Szabályzatok

API-szabályzatok

Hogyan verziózzuk a Data API-t, hogyan jelentjük be a megszüntetéseket és meddig tartanak, valamint hogyan jelenthető be egy biztonsági hiba.

Verziózás

Az API verziózása az útvonalban történik: minden végpont a /api/v1 alatt található. A szerződés info.version mezője (jelenleg 1.3.1) a változásnaplót követi: a minor szám akkor nő, ha valami új kerül bele, a patch szám akkor, ha valamit javítunk, és egy új útvonalverzió (/api/v2) az egyetlen mód arra, hogy kompatibilitástörő változás jelenjen meg.

A nyolc hivatalos SDK követi az API-t: egy új végpont minor SDK-kiadás, egy eltávolított vagy átnevezett végpont major kiadás.

Mi számít kompatibilitástörőnek

Ezek soha nem történnek meg egy útvonalverzión belül:

• Végpont, query paraméter vagy válaszmező eltávolítása vagy átnevezése.
• Egy mező típusának megváltoztatása, vagy annak a szabálynak a módosítása, hogy az árak, az árfolyamok és a kínálati adatok decimális sztringek.
• A { data, meta } boríték, a hibaboríték vagy egy meglévő hibakód jelentésének megváltoztatása.
• Egy csomagban már meglévő sebességkorlát vagy kvóta csökkentése.

Ezek bármikor megtörténhetnek, és a változásnaplóban jelentjük be őket:

• Új végpontok, query paraméterek és válaszmezők.
• Új hibakódok új helyzetekhez – mindig az error.code értékére illeszkedj, soha ne az üzenetre.
• Új értékek azokban a listákban, amelyekről a referencia azt írja, hogy bővülhetnek – például eseménynevek és indikátornevek.
• Magasabb korlátok és kvóták.

Megszüntetés

Ha egy végpont, paraméter vagy mező eltávolítása esedékessé válik, azt a változásnaplóban és e-mailben, minden kulcstulajdonosnak bejelentjük, és attól a naptól a végpont Deprecation és Sunset fejlécekkel (RFC 9745, RFC 8594) válaszol, amelyek megnevezik az eltávolítás dátumát. Az OpenAPI-szerződés a deprecated: true jelöléssel látja el.

Az eltávolításra legkorábban a bejelentés után hat hónappal kerül sor. Egy új útvonalverzió legalább hat hónapig fut az előző mellett, mielőtt a régit ugyanígy megszüntetnénk.

Korlátok és méltányos használat

A percenkénti burst-korlátok és a havi kvóták a csomagod részei; minden válaszban az X-RateLimit-* és az X-Quota-* fejlécek közlik őket, és a referenciában vannak dokumentálva. Egy korlát emelése soha nem kompatibilitástörő; a csomagon belüli csökkentése viszont igen, és a megszüntetési ütemezést követi.

Felelős hibabejelentés

Ha úgy gondolod, hogy biztonsági sérülékenységet találtál a bitculator.com oldalon, a Data API-ban, az MCP-kiszolgálón vagy az SDK-kban, írj a következő címre: contact@bitculator.com – add meg az érintett URL-t vagy végpontot, a reprodukálás lépéseit és a látott hatást. Három munkanapon belül válaszolunk.

Kérjük, tartsd bizalmasan a bejelentést, amíg a hibát ki nem javítjuk, ne férj hozzá és ne módosíts olyan adatot, amely nem a tiéd, és ne indíts szolgáltatásmegtagadási támadást vagy automatizált vizsgálatot az éles rendszer ellen. Az ezen feltételek szerint, jóhiszeműen tett bejelentések ellen nem lépünk fel jogi úton. Fizetett hibavadász program nincs; kérésre elismerést adunk.

Ugyanez az elérhetőség gépi olvasásra készen is közzé van téve a /.well-known/security.txt címen (RFC 9116).

Állapot és üzemzavarok

A komponensek élő állapota, a nyitott üzemzavarok és az elmúlt 30 nap kiesései az állapotoldalon és a /status.json címen érhetők el.