Bitculator
Udviklerkonsol

Politikker

API-politikker

Hvordan Data API'et versioneres, hvordan udfasninger annonceres og hvor længe de løber, og hvordan du rapporterer et sikkerhedsproblem.

Versionering

API'et versioneres i stien: hvert endpoint ligger under /api/v1. Kontraktens info.version (i øjeblikket 1.1.0) følger changeloggen: minor-nummeret stiger, når noget tilføjes, patch-nummeret, når noget rettes, og en ny stiversion (/api/v2) er den eneste måde, en breaking change udgives på.

De otte officielle SDK'er følger API'et: et nyt endpoint er en minor SDK-release, et fjernet eller omdøbt endpoint en major release.

Hvad tæller som breaking

Dette sker aldrig inden for en stiversion:

  • At fjerne eller omdøbe et endpoint, en query-parameter eller et svarfelt.
  • At ændre et felts type eller reglen om, at priser, kurser og forsyninger er decimalstrenge.
  • At ændre { data, meta }-envelopen, fejl-envelopen eller betydningen af en eksisterende fejlkode.
  • At sænke en rate limit eller kvote, som en plan allerede har.

Dette kan ske når som helst og annonceres i changeloggen:

  • Nye endpoints, query-parametre og svarfelter.
  • Nye fejlkoder til nye situationer - match altid på error.code, aldrig på beskeden.
  • Nye værdier i lister, som referencen siger kan vokse, såsom eventnavne og indikatornavne.
  • Højere grænser og kvoter.

Udfasning

Når et endpoint, en parameter eller et felt er planlagt til fjernelse, annonceres det i changeloggen og pr. e-mail til alle nøgleejere, og fra den dag svarer endpointet med Deprecation- og Sunset-headers (RFC 9745, RFC 8594), der angiver fjernelsesdatoen. OpenAPI-kontrakten markerer det med deprecated: true.

Fjernelse sker tidligst seks måneder efter annonceringen. En ny stiversion kører parallelt med den forrige i mindst seks måneder, før den gamle lukkes ned på samme måde.

Intet er i øjeblikket udfaset eller planlagt til fjernelse.

Grænser og fair use

Burst-grænser pr. minut og månedlige kvoter er en del af din plan, rapporteres på hvert svar i X-RateLimit-*- og X-Quota-*-headerne og er dokumenteret i referencen. At hæve en grænse er aldrig breaking; at sænke en inden for en plan er, og følger udfasningstidslinjen.

Responsible disclosure

Mener du at have fundet en sikkerhedssårbarhed i bitculator.com, Data API'et, MCP-serveren eller SDK'erne, så skriv til contact@bitculator.com med den berørte URL eller det berørte endpoint, trin til at genskabe den og den påvirkning, du ser. Du hører fra os inden for tre hverdage.

Hold venligst rapporten fortrolig, indtil fejlen er rettet, tilgå eller ændr ikke data, der ikke er dine, og kør ikke denial-of-service eller automatiseret scanning mod produktion. Rapporter indsendt i god tro på disse vilkår mødes ikke med retslige skridt. Der er intet betalt bounty-program; kreditering gives på forespørgsel.

Samme kontakt er offentliggjort maskinlæsbart på /.well-known/security.txt (RFC 9116).

Status og hændelser

Live-status for komponenterne, åbne hændelser og de seneste 30 dages nedbrud findes på statussiden og på /status.json.