Zásady

Zásady API

Ako sa verziuje dátové API, ako sa oznamuje ukončovanie podpory a ako dlho trvá, a ako nahlásiť bezpečnostný problém.

Verziovanie

API je verziované v ceste: každý koncový bod je pod /api/v1. Hodnota info.version v kontrakte (aktuálne 1.3.1) sa riadi changelogom: minor číslo stúpa, keď sa niečo pridá, patch číslo, keď sa niečo opraví, a nová verzia v ceste (/api/v2) je jediný spôsob, ako sa dostane von nekompatibilná zmena.

Osem oficiálnych SDK kopíruje API: nový koncový bod znamená minor vydanie SDK, odstránený alebo premenovaný koncový bod znamená major vydanie.

Čo sa považuje za nekompatibilnú zmenu

Toto sa v rámci jednej verzie v ceste nikdy nestane:

• Odstránenie alebo premenovanie koncového bodu, parametra dopytu či poľa odpovede.
• Zmena typu poľa alebo pravidla, že ceny, kurzy a ponuky sú desatinné reťazce.
• Zmena obálky { data, meta }, chybovej obálky alebo významu existujúceho chybového kódu.
• Zníženie limitu požiadaviek alebo kvóty, ktoré plán už má.

Toto sa môže stať kedykoľvek a oznamuje sa to v changelogu:

• Nové koncové body, parametre dopytu a polia odpovedí.
• Nové chybové kódy pre nové situácie – vždy porovnávajte error.code, nikdy nie samotnú správu.
• Nové hodnoty v zoznamoch, pri ktorých referenčná príručka uvádza, že sa môžu rozrastať, napríklad názvy udalostí a názvy indikátorov.
• Vyššie limity a kvóty.

Ukončovanie podpory

Keď je koncový bod, parameter alebo pole naplánované na odstránenie, oznámime to v changelogu a e-mailom každému majiteľovi kľúča a od toho dňa koncový bod odpovedá s hlavičkami Deprecation a Sunset (RFC 9745, RFC 8594), ktoré uvádzajú dátum odstránenia. Kontrakt OpenAPI ho označí ako deprecated: true.

K odstráneniu dôjde najskôr šesť mesiacov po oznámení. Nová verzia v ceste beží popri predchádzajúcej aspoň šesť mesiacov, kým sa tá stará rovnakým spôsobom neukončí.

Limity a férové používanie

Minútové nárazové limity a mesačné kvóty sú súčasťou vášho plánu, uvádzajú sa pri každej odpovedi v hlavičkách X-RateLimit-* a X-Quota-* a sú zdokumentované v referenčnej príručke. Zvýšenie limitu nikdy nie je nekompatibilnou zmenou; zníženie v rámci plánu áno a riadi sa harmonogramom ukončovania podpory.

Zodpovedné nahlasovanie

Ak sa domnievate, že ste našli bezpečnostnú zraniteľnosť na bitculator.com, v dátovom API, na serveri MCP alebo v SDK, napíšte na contact@bitculator.com a uveďte dotknutú URL alebo koncový bod, kroky na zopakovanie a dopad, ktorý vidíte. Ozveme sa vám do troch pracovných dní.

Hlásenie, prosím, ponechajte v tajnosti, kým nie je problém opravený, nepristupujte k údajom, ktoré vám nepatria, ani ich nemeňte a nespúšťajte proti produkcii útoky typu denial-of-service ani automatizované skenovanie. Proti hláseniam podaným v dobrej viere za týchto podmienok nepodnikneme právne kroky. Neexistuje platený program odmien; na požiadanie uvedieme vaše meno.

Ten istý kontakt je strojovo čitateľne zverejnený na /.well-known/security.txt (RFC 9116).

Stav a incidenty

Živý stav komponentov, otvorené incidenty a výpadky za posledných 30 dní nájdete na stránke so stavom a na /status.json.