Developer API

Uthibitishaji

Maombi yote ya API yanahitaji ufunguo wa API unaopitishwa kwenye kichwa cha X-API-Key / Authorization: Bearer.

Ili kuunda ufunguo wa API, nenda kwa Mipangilio ya Wasanidi Programu katika dashibodi yako. Unaweza kuwa na hadi funguo 5.

URL ya msingi

Vituo vyote vya mwisho vinarudisha JSON. Vituo vya mwisho vilivyowekwa kwenye ukurasa vinajumuisha meta kitu chenye current_page, last_page, na total.

Mitiririko

Kategoria

Watumiaji

Klipu

Mashindano

Viwango vya ELO

Ligi

Majibu ya Makosa

Hitilafu zote hurejesha bahasha thabiti ya JSON. Kipengee cha error kila mara huwa na code inayoweza kusomeka kwa mashine na message inayoweza kusomeka na binadamu.

Misimbo ya Hali

Marejeleo ya Misimbo ya Hitilafu

Vikomo vya Viwango

Maombi ya API yana kikomo kwa kila ufunguo wa API. Ukizidisha kikomo, maombi hurejesha 429 Too Many Requests yakiwa na kichwa cha Retry-After.

Mipaka kwa Daraja

Vichwa vya Kikomo cha Viwango

Maombi ya API yana kikomo kwa kila ufunguo wa API. Ukizidisha kikomo, maombi hurejesha 429 Too Many Requests yakiwa na kichwa cha Retry-After.

Mazoea Bora

Webhooks (EventSub)

Jiandikishe kwa arifa za wakati halisi zinazotumwa na programu badala ya kupiga kura. Tukio linapotokea, D1Arena hutuma HTTP POST kwa URL yako ya kupigiwa simu na malipo ya JSON yaliyotiwa saini na HMAC-SHA256.

Sanidi

Unda usajili wa mtandao katika Mipangilio ya Wasanidi Programu. Kila usajili unahitaji:

• URL ya kupiga simu — Mwisho wa HTTPS unaofikiwa na umma kwenye seva yako.
• Matukio — Aina moja au zaidi ya tukio la kujiandikisha.

You'll receive a whsec_ signing secret upon creation. Store it securely — it's shown only once.

Umbizo la Upakiaji

Kila utoaji wa mtandao hutuma mwili wa JSON na muundo huu:

Vichwa vya habari

Kila uwasilishaji unajumuisha vichwa vifuatavyo vya uelekezaji na uthibitishaji:

Inathibitisha Sahihi

Thibitisha kichwa cha X-D1Arena-Signature kila wakati kabla ya kuchakata webbook. Sahihi imekokotwa kama HMAC-SHA256(raw_body, webhook_secret).

Kwa usafirishaji wa v2, tumia whsec_ siri iliyoonyeshwa usajili ulipoundwa. Kwa usasishaji wa awali wa v1-hashed-secret, kwanza hesabu SHA256(whsec_secret) kutoka kwa siri hiyo asilia na utumie muhtasari wa herufi ndogo kama kitufe cha HMAC. Unda upya usajili inapowezekana ili kuhamia v2.

Matukio Yanayopatikana

Mifano ya Upakiaji wa Tukio

Sera ya Uwasilishaji na Ujaribu Tena

Mazoea Bora

• Thibitisha saini kila wakati kabla ya kuchakata mizigo ili kuzuia matukio ya udanganyifu.
• Tumia Kitambulisho cha Uwasilishaji kwa kukagua — hujaribu kutuma tena kitambulisho kile kile, kwa hivyo hifadhi vitambulisho vilivyochakatwa ili kuepuka kuchakata mara mbili.
• Jibu haraka, chakata bila usawa — rudisha 200 OK mara moja na ushughulikie mantiki ya biashara katika kazi ya usuli.
• Tumia ncha za HTTPS pekee — URL za wavuti lazima zitumie TLS. Simu za HTTP zimekataliwa.
• Shughulikia matukio yasiyojulikana kwa uzuri — aina mpya za tukio zinaweza kuongezwa. Rudisha 200 kwa matukio yasiyotambulika badala ya kufanya makosa.

D1 Mshtuko

D1 Frenzy huanzishwa na vidokezo vya haraka na usajili wakati mtiririshaji yuko moja kwa moja. Inaendelea kupitia viwango 5 na malengo yanayoongezeka.

GET /api/overdrive/{streamerId}

Pata msisimko wa D1 kwa mtiririshaji. Hurejesha {"active": false} ikiwa hakuna.

Malengo ya Ngazi

D1 Mshtuko — Pointi: Kidokezo $1 → 100; Usajili 500 × Daraja. Muda: 5 Dakika; Kupunguza joto: 30 Dakika.

SDK ya Kiendelezi

Unda kidirisha maalum na viendelezi vyawekele ambavyo watiririshaji wanaweza kusakinisha kwenye kurasa za vituo vyao. Viendelezi huendeshwa katika iframes za sandbox na kuwasiliana na ukurasa wa seva pangishi kupitia postMessage.

Kuanza

1. Unda ufunguo wa API katika Mipangilio ya Wasanidi Programu.
2. Unda kiendelezi chako kama ukurasa wa HTML wa kujitegemea unaopangishwa kwenye kikoa chako (HTTPS inahitajika).
3. Iwasilishe kwa ukaguzi katika sehemu ya Viendelezi Vyangu.
4. Baada ya kuidhinishwa, vipeperushi vinaweza kusakinisha kutoka kwa Soko la Kiendelezi.

Aina za Upanuzi

postMessage API

Kiendelezi chako hupokea data ya muktadha kiotomatiki inapopakia. Tekeleza matukio haya:

Tumia D1Arena asili halisi ya mzazi kwa kila ujumbe. SDK rasmi hupata na kuhalalisha asili hii kutoka kwa ukurasa wa kupachika kiotomatiki.

Kwa sababu iframe za kiendelezi hutumia kimakusudi asili ya kisanduku kisicho wazi, mwenyeji wa D1Arena huthibitisha dirisha kamili la iframe lililosajiliwa. Msimbo wa kiendelezi bado lazima uthibitishe dirisha kuu na asili halisi ya D1Arena kabla ya kukubali muktadha.

1. Utayari wa ishara

2. Pokea muktadha

3. Tuma vitendo (si lazima)

Mawanda ya Ruhusa

Tamka ni data gani kiendelezi chako kinahitaji. Wakaguzi huthibitisha nambari yako ya kuthibitisha inalingana na ruhusa ulizotangaza.

Mahitaji ya Usalama

• HTTPS ya umma inahitajika — URL yako ya iframe lazima itumie TLS na kutatua tu kwa anwani za mtandao wa umma.
• Chanzo kinachoweza kusomeka na binadamu — Hakuna JavaScript iliyofichwa au iliyopunguzwa tu. Wakaguzi lazima waweze kusoma nambari yako.
• Hakuna upakiaji wa hati ya nje isipokuwa kama itatangazwa katika uwasilishaji wako. Maktaba za CDN (jQuery, Chart.js, n.k.) ziko sawa.
• Hakuna uchujaji wa data — Viendelezi havipaswi kutuma data ya watazamaji kwa uchanganuzi wa watu wengine au huduma za ufuatiliaji.
• Sera ya maudhui — Hakuna matangazo, maudhui ya NSFW, uchimbaji madini ya cryptocurrency, au tabia mbaya.

Mchakato wa Mapitio

Sasisho za Toleo

Ili kusasisha kiendelezi kilichoidhinishwa, futa toleo la sasa na uwasilishe jipya lenye nambari ya toleo lililoongezwa. Toleo jipya linapitia ukaguzi tena.

Changelog

Fuatilia mabadiliko ya API na vipengele vipya. Tunafuata matoleo ya kisemantiki na kutangaza mabadiliko yasiyobadilika angalau siku 30 kabla.

Je, unahitaji Msaada?

Je, una maswali kuhusu API? Wasiliana nasi.