Yoruba.tech

Àkọsílẹ̀ olùgbékalẹ̀

Pe àtùmọ̀ Àtùmọ̀ Tech, fi wíwá sí ojú òpó rẹ, kí o sì ṣàmójútó lílo pẹ̀lú kírẹ́dìtì tí a san tẹ́lẹ̀.

Bẹ̀rẹ̀ níbí

  1. Ṣẹ̀dá app Gba Client ID àti API key láti ibi olùgbékalẹ̀. App tuntun ní 1,000 kírẹ́dìtì ìbẹ̀rẹ̀.
  2. Pe API Fi Authorization: Bearer yt_… (tàbí X-API-Key) ránṣẹ́. Ìbéèrè tí ó ṣe é ń lo kírẹ́dìtì.
  3. Ṣàmójútó ìwọ̀ntúnwònsì Lo àwọn header èsì, GET /credits.php, tàbí àwòrán lórí ojú app. Fi Paystack kún kírẹ́dìtì nígbà tí ó bá nílò.

Ìfàsẹ̀yìn & àyè

Gbogbo ìbéèrè API nílò kókó tí a fi hàn ní ẹ̀ẹ̀kan ṣoṣo nígbà tí o ṣẹ̀dá tàbí ṣe àtúnṣe app.

Authorization: Bearer yt_…

tàbí

X-API-Key: yt_…

Àwọn àyè

  • dictionary:read
  • dictionary:write

Kírẹ́dìtì

San bó ṣe ń lo. Ìwọ̀ntúnwònsì tó ṣófo → 402 pẹ̀lú top_up_url.

Ẹ̀bùn ìbẹ̀rẹ̀
1,000 kírẹ́dìtì
Iye API
1 / ìbéèrè
Iye embed
1 / wíwá
Fíkun
Paystack lórí ojú app

Àwọn ìdìpọ̀

  • Starter 2,000 kírẹ́dìtì ₦1,000
  • Growth 10,000 kírẹ́dìtì ₦4,000
  • Scale 50,000 kírẹ́dìtì ₦15,000

Àwọn header èsì

Wà lórí ìbéèrè tí a gba owó fún. JS browser pàápàá lè rí wọn nípasẹ̀ CORS expose headers.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
X-Credit-Balance
X-Credit-Cost
X-Commercial-Use

Àwọn ọ̀nà API

GET /api/v1/credits.php

Ìwọ̀ntúnwònsì àti lílo ọjọ́ méje. Kò lo kírẹ́dìtì; kò sì ka sí ìdíwọ̀n wákàtí. Kò lo kírẹ́dìtì

curl -H "Authorization: Bearer yt_…" \
  "https://techinyoruba.ai/api/v1/credits.php"

Ń dá credit_balance, costs, àti usage padà (spent_today, spent_7d, API vs embed, ìdíwọ̀n ọjọ́ tó kù, by_day).

GET /api/v1/dictionary.php

Nílò dictionary:read. Wá àwọn ọ̀rọ̀ tí a fọwọ́sí.

ParamÀlàyé
qWá Gẹ̀ẹ́sì tàbí Yorùbá
categoryOrúkọ ẹ̀ka tàbí slug
slugSlug ọ̀rọ̀ gangan (ọ̀kan péré)
letterÀlẹ̀mọ́ A–Z lórí ọ̀rọ̀ Gẹ̀ẹ́sì
limitIye èsì púpọ̀ jùlọ (default 100, max 500)

Ohun kọ̀ọ̀kan ní id, slug, url, english, yoruba, àwọn ìtumọ̀, category, example, àti URL média.

curl -H "Authorization: Bearer yt_…" \
  "https://techinyoruba.ai/api/v1/dictionary.php?q=api&limit=10"
curl -H "Authorization: Bearer yt_…" \
  "https://techinyoruba.ai/api/v1/dictionary.php?category=AI&letter=M&limit=20"

POST /api/v1/suggest.php

Nílò dictionary:write. Fi àbá àtúnṣe sílẹ̀ fún àyẹ̀wò òṣìṣẹ́.

curl -X POST -H "Authorization: Bearer yt_…" -H "Content-Type: application/json" \
  -d '{"slug":"cloud","suggested_yoruba":"ìkùràwọ́","notes":"tone fix"}' \
  "https://techinyoruba.ai/api/v1/suggest.php"

Whitelist

Yàn fún app kọ̀ọ̀kan. Fi sílẹ̀ òfo láti gba gbogbo.

Whitelist IP
IP gangan tàbí CIDR (bíi 203.0.113.10, 198.51.100.0/24). Òmíràn gba 403.
Whitelist origin
Origin browser tàbí host (bíi https://app.example.com, *.example.com). Pàtàkì fún embed iṣẹ́ gidi. Ìpè server-to-server láìsí Origin ṣì wà ní ààyè.

Webhook àjọṣepọ̀

Ṣeto HTTPS endpoint lórí ojú àlàyé app. Àwọn ìfiránṣẹ́ ní:

X-YorubaTech-Event: dictionary.term.approved
X-YorubaTech-Signature: sha256=…

Signature jẹ́ HMAC-SHA256 ti JSON body nípasẹ̀ aṣírí webhook.

  • dictionary.term.approved
  • dictionary.suggestion.accepted
  • dictionary.term.submitted

Àtùmọ̀ embed

Fi wíwá àtùmọ̀ Yoruba.tech sí ojú òpó ayélujára rẹ pẹ̀lú client ID app òǹṣe rẹ.

Wíwá embed ń lo kírẹ́dìtì kannáà (1 fún wíwá kan). Fi origin ojú òpó rẹ sí whitelist app fún iṣẹ́ gidi.

Bẹ̀rẹ̀ kíákíá

Lẹ̀ẹ́ koodu yìí sí body — lo client ID app òǹṣe rẹ.

<script src="https://techinyoruba.ai/embed/dictionary.js"
        data-base="https://techinyoruba.ai"
        data-client-id="app_YOUR_CLIENT_ID"
        data-container="yt-dict-embed"
        defer></script>
<div id="yt-dict-embed"></div>

Ṣẹ̀dá app òǹṣe láti gba client ID: Olùgbékalẹ̀.

Àwọn aṣayan

ÀmìÀlàyé
data-client-id Pàtàkì. Client ID app òǹṣe rẹ (app_…).
data-base URL Yoruba.tech (default láti script).
data-container ID apoti widget.

Ibi wíwá: GET https://techinyoruba.ai/embed/search?client_id=…&q=… (CORS + origin whitelist).

Àfihàn gidi

Wọlé kí o sì ṣẹ̀dá app òǹṣe láti dán àfihàn yìí wò.

Wọlé

Àṣìṣe

{"ok": false, "error": "…"}
IpòÌtumọ̀
401API key kò sí tàbí kò tọ́
403Àyè kò pé, app ti fagilé, tàbí whitelist dí i
402Kírẹ́dìtì kò tó (ní top_up_url)
429Ìdíwọ̀n ààbò wákàtí ti kọjá

Ṣe igbasilẹ openapi.yaml fún schema tí ẹ̀rọ lè ka.