Wordly API দিয়ে তৈরি করুন।

কুইকস্টার্ট

একটি বিনামূল্যের অ্যাকাউন্ট তৈরি করুন, ছয়-সংখ্যার কোড ব্যবহার করে আপনার ইমেল যাচাই করুন এবং আপনার ডেভেলপার ড্যাশবোর্ডে একবার দেখানো API কীটি অনুলিপি করুন।

1. 1
   একটি অ্যাকাউন্ট তৈরি করুন

   শুধুমাত্র একটি ইমেল ঠিকানা এবং পাসওয়ার্ড দিয়ে নিবন্ধন করুন.

2. 2
   আপনার ইমেল যাচাই করুন

   প্রেরিত কোড লিখুন [email protected]. Verification grants 50 free credits.

3. 3
   আপনার API কী সংরক্ষণ করুন

   উত্পন্ন অনুলিপি wly_live_... কী এবং এটিকে সার্ভার-সাইড এনভায়রনমেন্ট ভেরিয়েবলে রাখুন।

4. 4
   একটি পরীক্ষা অনুরোধ করুন

   প্রমাণীকরণ যাচাই করতে এবং অবশিষ্ট ব্যালেন্স দেখতে অ্যাকাউন্ট এন্ডপয়েন্টে কল করুন।

curl "https://api.wordlyenglish.com/v1/account" \
  -H "Authorization: Bearer $WORDLY_API_KEY" \
  -H "Accept: application/json"

{
  "data": {
    "message": "Authenticated",
    "credits_remaining": 50
  },
  "meta": { "lang": "en" }
}

বেস ইউআরএল এবং সংস্করণ

সমস্ত প্রোডাকশন এন্ডপয়েন্টগুলি নিম্নলিখিত সংস্করণযুক্ত বেস URL থেকে পরিবেশিত হয়:

ব্রেকিং প্রতিক্রিয়া বা আচরণ পরিবর্তন একটি নতুন পাথ সংস্করণ ব্যবহার করবে। সংযোজন ক্ষেত্র মধ্যে চালু করা যেতে পারে v1, so clients should ignore response properties they do not recognize.

প্রমাণীকরণ

প্রমাণীকৃত এন্ডপয়েন্টের জন্য HTTP-তে একটি API কী প্রয়োজন Authorization Bearer স্কিম ব্যবহার করে হেডার।

Authorization: Bearer wly_live_your_api_key

স্থানীয়কৃত API বার্তা

এর সাথে প্রতিক্রিয়ার ভাষা সেট করুন ?lang=tr বা মান Accept-Language হেডার ক্যোয়ারী পরামিতি অগ্রাধিকার নিতে. প্রতিটি JSON প্রতিক্রিয়া নির্বাচিত লোকেল ঘোষণা করে Content-Language এবং meta.lang. Error codes remain stable in English for programmatic handling; only the human-readable message is localized.

curl "https://api.wordlyenglish.com/v1/account?lang=tr" \
  -H "Authorization: Bearer $WORDLY_API_KEY" \
  -H "Accept-Language: tr-TR"

সমর্থিত ভাষা কোড: en, tr, de, fr, es, it, pt, nl, pl, ru, uk, ar, fa, he, hi, bn, ur, zh, ja, ko, id, ms, vi, th, sv, no, da, fi, cs, ro.

ক্রেডিট এবং বিলিং

Each successful metered request consumes the documented number of credits. Email-verified accounts receive 50 free credits once. Credits are deducted atomically, so concurrent requests cannot spend the same balance twice. Balance lookup through GET /v1/account is free.

Use GET /v1/account when you need the current balance. Other endpoint responses include the operation charge but omit the remaining balance. When the balance is insufficient, the API returns HTTP 402 এবং অপারেশন প্রক্রিয়া করে না।

{
  "error": {
    "code": "credits_exhausted",
    "message": "Your credit balance is exhausted. Add a package or enable pay-as-you-go to continue.",
    "upgrade_url": "/app.php?page=billing"
  }
}

API key lifecycle

উন্নয়ন, মঞ্চায়ন এবং উৎপাদনের জন্য পৃথক কী তৈরি করুন। Wordly প্রতিটি কী-এর শুধুমাত্র একটি ক্রিপ্টোগ্রাফিক হ্যাশ সংরক্ষণ করে; সম্পূর্ণ মান তৈরি করার সময় একবার প্রদর্শিত হয়।

• পরিবেশ বা পরিষেবা অনুসারে নাম কী।
• পরিবেশ ভেরিয়েবল বা একটি পরিচালিত গোপন দোকান ব্যবহার করুন.
• একটি চাবি উন্মুক্ত হয়ে থাকলে অবিলম্বে প্রত্যাহার করুন।
• পুরানো মান পুনরায় ব্যবহার না করে কী ঘোরান।
• ক্যোয়ারী স্ট্রিং-এ কী পাঠাবেন না।

প্রতিক্রিয়া বিন্যাস

সফল প্রতিক্রিয়া একটি শীর্ষ স্তর ব্যবহার করে data বস্তু এবং একটি অন্তর্ভুক্ত হতে পারে meta বস্তু ত্রুটিগুলি সর্বদা একটি শীর্ষ-স্তর ব্যবহার করে error একটি স্থিতিশীল মেশিন-পাঠযোগ্য বস্তু সহ code এবং একটি মানুষের পাঠযোগ্য message.

{
  "data": { ... },
  "meta": {
    "credits_used": 1,
    "request_id": "..."
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "..."
  }
}

রাখুন request_id একটি সফল বিল করা অনুরোধ সম্পর্কে সমর্থনের সাথে যোগাযোগ করার সময়। JSON UTF-8 এনকোডেড এবং ক্লায়েন্টদের পাঠাতে হবে Accept: application/json.

উত্পাদনের শেষ পয়েন্ট

শব্দভান্ডারের শেষ পয়েন্ট

GET /v1/words/{word}

একটি সঠিক শব্দ মিল প্রদান করে। ব্যবহার করুন languages=tr,de,fr শুধুমাত্র অনুরোধকৃত অনুবাদ ফেরত দিতে। ক্যাটালগ বা অনুবাদিত রেকর্ডের জন্য 1 ক্রেডিট খরচ হয়; সম্পূর্ণরূপে সমৃদ্ধ প্রোফাইল 5 ক্রেডিট খরচ.

curl "https://api.wordlyenglish.com/v1/words/water?languages=tr,de" \
  -H "Authorization: Bearer $WORDLY_API_KEY"

GET /v1/words/search

সঙ্গে অনুসন্ধান করুন q এবং ঐচ্ছিক level, part_of_speech, category, limit, and cursor. Limits range from 1 to 50. Pass meta.next_cursor পরবর্তী অনুরোধে

curl "https://api.wordlyenglish.com/v1/words/search?q=app&level=advanced&limit=20" \
  -H "Authorization: Bearer $WORDLY_API_KEY"

GET /v1/words/random

1-20 এলোমেলো শব্দ প্রদান করে। দ্বারা ফিল্টার level, part_of_speech, or category. Each returned slot costs one credit.

POST /v1/words/batch

একক অনুরোধে 1 থেকে 50টি অনন্য শব্দের মধ্যে দেখা যায়। প্রতিক্রিয়া অনুরোধের আদেশ সংরক্ষণ করে এবং প্রতিটি আইটেমকে চিহ্নিত করে found.

curl -X POST "https://api.wordlyenglish.com/v1/words/batch?lang=tr" \
  -H "Authorization: Bearer $WORDLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"words":["water","opportunity"],"languages":["tr","de"]}'

GET /v1/languages

সমস্ত 30টি সমর্থিত ইন্টারফেস এবং API-বার্তা লোকেল ফেরত দেয়। শব্দভান্ডারের অনুবাদগুলি শুধুমাত্র উপলব্ধ হলেই ফেরত দেওয়া হয়। এই শেষ বিন্দু সর্বজনীন এবং শূন্য ক্রেডিট খরচ.

হার সীমা

প্রতিটি API কী প্রতি রোলিং মিনিটে 120টি স্বীকৃত অনুরোধের মধ্যে সীমাবদ্ধ। প্রতিক্রিয়া অন্তর্ভুক্ত X-RateLimit-Limit এবং X-RateLimit-Remaining. A 429 rate_limit_exceeded প্রতিক্রিয়া অন্তর্ভুক্ত Retry-After: 60.

Response field reference

Every stable response variable is described below. Additive fields may appear later, so clients should ignore fields they do not recognize.

Vocabulary object

Meta object

Error object

ত্রুটি

প্রস্তাবিত পুনরায় চেষ্টা নীতি

আবার চেষ্টা করবেন না 401, 402, or 404 স্বয়ংক্রিয়ভাবে ক্ষণস্থায়ী জন্য 5xx প্রতিক্রিয়া, জিটার সহ সূচকীয় ব্যাকঅফ ব্যবহার করুন এবং একটি কঠোর পুনরায় চেষ্টা করুন ক্যাপ। একটি সীমাহীন পুনঃপ্রচেষ্টা লুপ তৈরি করবেন না কারণ প্রতিটি গৃহীত প্রমাণীকৃত অনুরোধ ক্রেডিট গ্রাস করতে পারে।

JavaScript/ Node.js

const response = await fetch('https://api.wordlyenglish.com/v1/account', {
  headers: {
    Authorization: `Bearer ${process.env.WORDLY_API_KEY}`,
    Accept: 'application/json'
  }
});

const body = await response.json();
if (!response.ok) {
  throw new Error(`${body.error.code}: ${body.error.message}`);
}

console.log(body.data.credits_remaining);

পাইথন

import os
import requests

response = requests.get(
    'https://api.wordlyenglish.com/v1/account',
    headers={
        'Authorization': f'Bearer {os.environ["WORDLY_API_KEY"]}',
        'Accept': 'application/json',
    },
    timeout=15,
)
response.raise_for_status()
print(response.json()['data']['credits_remaining'])

পিএইচপি

$curl = curl_init('https://api.wordlyenglish.com/v1/account');
curl_setopt_array($curl, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 15,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WORDLY_API_KEY'),
    'Accept: application/json',
  ],
]);

$body = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);

if ($status >= 400) {
  throw new RuntimeException('Wordly API request failed');
}
$data = json_decode($body, true, flags: JSON_THROW_ON_ERROR);

ডার্ট/ফ্লাটার

ফ্লটার অ্যাপ্লিকেশনের ভিতরে Wordly কী পাঠাবেন না। উদাহরণটি একটি বিশ্বস্ত ডার্ট ব্যাকএন্ড বা সার্ভার ফাংশনের অন্তর্গত।

final response = await http.get(
  Uri.parse('https://api.wordlyenglish.com/v1/account'),
  headers: {
    'Authorization': 'Bearer ${Platform.environment['WORDLY_API_KEY']}',
    'Accept': 'application/json',
  },
);

final body = jsonDecode(response.body) as Map<String, dynamic>;
if (response.statusCode >= 400) {
  throw Exception((body['error'] as Map)['code']);
}

উত্পাদন চেকলিস্ট

• প্রক্সি ওয়ার্ডলি একটি বিশ্বস্ত ব্যাকএন্ডের মাধ্যমে অনুরোধ করে।
• সংযোগ এবং প্রতিক্রিয়া সময়সীমা সেট করুন।
• হ্যান্ডেল 401, 402, 404, and 5xx আলাদাভাবে
• Query GET /v1/account when your application needs the current balance.
• লগ এন্ডপয়েন্ট, স্ট্যাটাস, লেটেন্সি, এবং request_id API কী লগিং ছাড়াই।
• পরিবেশ প্রতি পৃথক কী ব্যবহার করুন এবং পর্যায়ক্রমে তাদের ঘোরান।
• Cache stable vocabulary responses in your backend when appropriate.