Kelime API'si

Anahtarınız

Anahtarı Authorization başlığında bearer olarak ya da X-API-Key başlığında gönderin.

Ücretsiz düzey

Ücretsiz bir anahtarla günde 10 çağrı yapabilirsiniz. Sayaç her gün 00:00 UTC'de sıfırlanır. Veri döndüren bir uç noktaya yapılan her çağrı bir sayılır. X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıkları ne kadar hakkınız kaldığını gösterir.

Uç noktalar

Tüm yollar /api/v1 ile başlar. Tam açıklama OpenAPI dosyasındadır.

• GET /api/v1/words Süzgeçlere uyan sözcükler
• GET /api/v1/words/{word} Bu yazımdaki tüm maddeler
• GET /api/v1/themes Sözcüğü olan konular, sayılar ve adlarla
• GET /api/v1/themes/{theme}/words Bir konudaki sözcükler
• GET /api/v1/levels Sözcüğü olan CEFR düzeyleri, sayılarla
• GET /api/v1/levels/{level}/words Bir düzeydeki sözcükler
• GET /api/v1/word-of-the-day Bugünün sözcüğü (UTC)
• GET /api/v1/word-of-the-day/{date} Bir günün sözcüğü, YYYY-AA-GG
• GET /api/v1/random Rastgele sözcükler, hiç önbelleğe alınmaz
• GET /api/v1/export/words.json Görünen tüm sözcükler JSON olarak
• GET /api/v1/export/words.csv Görünen tüm sözcükler CSV olarak
• GET /api/v1/meta Veri sürümü, sayılar, görünen inceleme durumları, lisanslar. Açık, anahtar gerekmez. (Anahtar gerekmez)

OpenAPI açıklaması (JSON)

review_status alanı

Her değerin, ne kadar denetlendiğini söyleyen bir review_status alanı vardır: owner (sahibi girdi veya onayladı), reviewed, imported (açık bir kaynaktan alındı), machine (henüz bir kişinin denetlemediği makine taslağı) ve draft. /meta uç noktası API'nin şu an hangi durumları gönderdiğini listeler. Yalnızca denetlenmiş veri istiyorsanız bu alana bakın.

Hatalar

Her hatanın biçimi aynıdır: status, code ve message içeren bir error nesnesi.

• bad_request: 400: bir parametre yanlış. İleti hangisi olduğunu söyler.
• unauthorized: 401: anahtar yok, bilinmiyor veya iptal edilmiş.
• forbidden: 403: bu anahtar bu uç noktayı kapsamıyor.
• not_found: 404: eşleşen bir şey yok.
• rate_limited: 429: anahtar bugünkü çağrılarını kullandı. Retry-After başlığı 00:00 UTC'ye kalan saniyeyi verir.
• server_error: 500: bizim tarafımızda bir sorun oldu. Daha sonra tekrar deneyin.

Örnek

Aynı çağrı curl, JavaScript ve Python ile. YOUR_KEY yerine kendi anahtarınızı yazın ve asla herkese açık koda koymayın.

curl -H "Authorization: Bearer ih_live_YOUR_KEY" \
  "https://inburgering.help/api/v1/words/fiets?lang=en,fa"

const response = await fetch("https://inburgering.help/api/v1/words/fiets?lang=en,fa", {
  headers: { Authorization: "Bearer ih_live_YOUR_KEY" },
});
if (response.status === 429) {
  // Over the limit: try again after this many seconds.
  console.log("Retry after", response.headers.get("Retry-After"));
} else if (!response.ok) {
  console.log((await response.json()).error.message);
} else {
  console.log(await response.json());
}

import requests

response = requests.get(
    "https://inburgering.help/api/v1/words/fiets?lang=en,fa",
    headers={"Authorization": "Bearer ih_live_YOUR_KEY"},
    timeout=10,
)
if response.status_code == 429:
    # Over the limit: try again after this many seconds.
    print("Retry after", response.headers["Retry-After"])
else:
    response.raise_for_status()
    print(response.json())

Sürümler ve değişiklikler

API şu anda 1. sürümde (/api/v1). Bir sürümün içinde yalnızca alan ve uç nokta eklenir; tanımadığınız alanları yok sayın. Bir istemciyi bozabilecek değişiklik yeni bir sürüm alır; eski sürüm kapatılmadan önce duyurulan bir süre boyunca erişilebilir kalır. Değişiklikler aşağıda.

• v1
  • İlk sürüm: sözcükler, konular, düzeyler, günün sözcüğü, rastgele sözcükler, dışa aktarma ve meta.
  • Düzey başına günlük sınırlı anahtarlar; isteğe bağlı aylık sınır, düzey başına inceleme durumları ve yetkiler (okuma, dışa aktarma).
  • Konu adları Hollandaca ve İngilizce; Farsça, Arapça ve Türkçe konu adları taslaktır (themes yanıtı bunları labels_draft içinde bildirir).

API anahtarı isteyin

Anahtarlar henüz yeni başvuranlara verilmiyor. Lütfen daha sonra tekrar bakın.