Zásady

Zásady API

Jak se Data API verzuje, jak se oznamuje ukončení podpory a jak dlouho trvá, a jak nahlásit bezpečnostní problém.

Verzování

API se verzuje v cestě: každý endpoint žije pod /api/v1. info.version kontraktu (aktuálně 1.1.0) se řídí changelogem: minor číslo roste, když se něco přidá, patch číslo, když se něco opraví, a nová verze cesty (/api/v2) je jediný způsob, jak vydat nekompatibilní změnu.

Osm oficiálních SDK sleduje API: nový endpoint znamená minor vydání SDK, odstraněný nebo přejmenovaný endpoint major vydání.

Co se počítá jako nekompatibilní změna

Tohle se v rámci jedné verze cesty nikdy nestane:

Odstranění nebo přejmenování endpointu, query parametru nebo pole odpovědi.
Změna typu pole nebo pravidla, že ceny, kurzy a nabídky jsou desetinné řetězce.
Změna obálky { data, meta }, chybové obálky nebo významu existujícího chybového kódu.
Snížení rychlostního limitu nebo kvóty, které plán už má.

Tohle se může stát kdykoli a oznamuje se v changelogu:

Nové endpointy, query parametry a pole odpovědí.
Nové chybové kódy pro nové situace - vždy porovnávejte error.code, nikdy zprávu.
Nové hodnoty v seznamech, o nichž reference říká, že mohou růst, například názvy událostí a názvy indikátorů.
Vyšší limity a kvóty.

Ukončování podpory

Když je endpoint, parametr nebo pole naplánováno k odstranění, oznámí se to v changelogu a e-mailem každému majiteli klíče a od toho dne endpoint odpovídá s hlavičkami Deprecation a Sunset (RFC 9745, RFC 8594), které uvádějí datum odstranění. OpenAPI kontrakt ho označí deprecated: true.

K odstranění dojde nejdříve šest měsíců po oznámení. Nová verze cesty běží souběžně s předchozí nejméně šest měsíců, než je stará stejným způsobem ukončena.

Aktuálně nic není zastaralé ani naplánované k odstranění.

Limity a fair use

Minutové burst limity a měsíční kvóty jsou součástí vašeho plánu, hlásí se u každé odpovědi v hlavičkách X-RateLimit-* a X-Quota-* a jsou zdokumentovány v referenční příručce. Zvýšení limitu nikdy není nekompatibilní změna; snížení v rámci plánu ano a řídí se harmonogramem ukončování podpory.

Odpovědné hlášení zranitelností

Pokud se domníváte, že jste našli bezpečnostní zranitelnost na bitculator.com, v Data API, MCP serveru nebo SDK, napište na contact@bitculator.com a uveďte dotčenou URL nebo endpoint, kroky k reprodukci a dopad, který pozorujete. Odpověď dostanete do tří pracovních dnů.

Prosíme, držte hlášení v tajnosti, dokud není problém opraven, nepřistupujte k datům, která nejsou vaše, ani je neupravujte a nespouštějte proti produkci denial-of-service ani automatizované skenování. Hlášení podaná v dobré víře za těchto podmínek nebudou stíhána právní cestou. Placený bounty program neexistuje; na požádání uvedeme vaše jméno.

Stejný kontakt je strojově čitelně publikován na /.well-known/security.txt (RFC 9116).

Stav a incidenty

Živý stav komponent, otevřené incidenty a výpadky za posledních 30 dní najdete na stavové stránce a na /status.json.