สร้างด้วย 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 ฐานและการกำหนดเวอร์ชัน

จุดสิ้นสุดการใช้งานจริงทั้งหมดให้บริการจาก URL พื้นฐานที่มีเวอร์ชันต่อไปนี้:

การตอบสนองที่ไม่สมบูรณ์หรือการเปลี่ยนแปลงพฤติกรรมจะใช้เวอร์ชันเส้นทางใหม่ อาจมีการแนะนำช่องเพิ่มเติมภายใน v1, so clients should ignore response properties they do not recognize.

การรับรองความถูกต้อง

ตำแหน่งข้อมูลที่ได้รับการตรวจสอบสิทธิ์ต้องใช้คีย์ API ใน HTTP 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

ส่งคืนอินเทอร์เฟซที่รองรับและตำแหน่งข้อความ API ทั้งหมด 30 รายการ การแปลคำศัพท์จะถูกส่งกลับเมื่อมีให้เท่านั้น ตำแหน่งข้อมูลนี้เป็นสาธารณะและมีค่าใช้จ่ายเป็นศูนย์เครดิต

ขีดจำกัดอัตรา

คีย์ 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 การตอบกลับ ให้ใช้การถอยกลับแบบเอกซ์โปเนนเชียลโดยมีการกระวนกระวายใจและจำกัดการลองใหม่อย่างเข้มงวด อย่าสร้างการวนซ้ำแบบไม่มีขอบเขต เนื่องจากคำขอตรวจสอบสิทธิ์ที่ยอมรับแต่ละรายการอาจใช้เครดิต

จาวาสคริปต์ / 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'])

PHP

$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 ภายในแอปพลิเคชัน Flutter ตัวอย่างนี้อยู่ในแบ็กเอนด์ Dart หรือฟังก์ชันเซิร์ฟเวอร์ที่เชื่อถือได้

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']);
}

รายการตรวจสอบการผลิต

• Proxy Wordly ร้องขอผ่านแบ็กเอนด์ที่เชื่อถือได้
• ตั้งค่าการหมดเวลาการเชื่อมต่อและการตอบสนอง
• มือจับ 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.