वर्डली एपीआई के साथ निर्माण करें।

त्वरित शुरुआत

एक मुफ़्त खाता बनाएं, छह अंकों के कोड का उपयोग करके अपना ईमेल सत्यापित करें, और अपने डेवलपर डैशबोर्ड में दिखाई गई एपीआई कुंजी को एक बार कॉपी करें।

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 में एक एपीआई कुंजी की आवश्यकता होती है Authorization बियरर योजना का उपयोग करते हुए हेडर।

Authorization: Bearer wly_live_your_api_key

स्थानीयकृत एपीआई संदेश

प्रतिक्रिया भाषा को इसके साथ सेट करें ?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

विकास, स्टेजिंग और उत्पादन के लिए अलग-अलग कुंजियाँ बनाएँ। वर्डली प्रत्येक कुंजी का केवल एक क्रिप्टोग्राफ़िक हैश संग्रहीत करता है; संपूर्ण मान निर्माण के समय एक बार प्रदर्शित होता है।

• परिवेश या सेवा के अनुसार कुंजियाँ नाम दें.
• पर्यावरण चर या प्रबंधित गुप्त स्टोर का उपयोग करें।
• यदि कोई कुंजी उजागर हो गई हो तो उसे तुरंत रद्द करें।
• पुराने मानों का पुन: उपयोग किए बिना कुंजियाँ घुमाएँ।
• क्वेरी स्ट्रिंग में कुंजियाँ न भेजें.

प्रतिक्रिया स्वरूप

सफल प्रतिक्रियाएँ शीर्ष-स्तर का उपयोग करती हैं 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 समर्थित इंटरफ़ेस और एपीआई-संदेश स्थान लौटाता है। शब्दावली अनुवाद केवल तभी लौटाए जाते हैं जब उपलब्ध हों। यह समापन बिंदु सार्वजनिक है और इसकी लागत शून्य क्रेडिट है।

दर सीमा

प्रत्येक एपीआई कुंजी प्रति रोलिंग मिनट में 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 प्रतिक्रियाएँ, घबराहट और एक सख्त पुनः प्रयास सीमा के साथ घातीय बैकऑफ़ का उपयोग करें। कभी भी अनबाउंड रिट्री लूप न बनाएं क्योंकि प्रत्येक स्वीकृत प्रमाणित अनुरोध क्रेडिट का उपभोग कर सकता है।

जावास्क्रिप्ट / नोड.जे.एस

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);

डार्ट/फड़फड़ाहट

फ़्लटर एप्लिकेशन के अंदर वर्डली कुंजी न भेजें। उदाहरण एक विश्वसनीय डार्ट बैकएंड या सर्वर फ़ंक्शन से संबंधित है।

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 एपीआई कुंजी लॉग किए बिना।
• प्रत्येक परिवेश के लिए अलग-अलग कुंजियों का उपयोग करें और उन्हें समय-समय पर घुमाएँ।
• Cache stable vocabulary responses in your backend when appropriate.