Retningslinjer

API-retningslinjer

Hvordan Data API-et versjoneres, hvordan utfasinger kunngjøres og hvor lenge de løper, og hvordan du rapporterer et sikkerhetsproblem.

Versjonering

API-et versjoneres i stien: hvert endepunkt ligger under /api/v1. Kontraktens info.version (for øyeblikket 1.1.0) følger endringsloggen: minor-tallet øker når noe legges til, patch-tallet når noe rettes, og en ny stiversjon (/api/v2) er den eneste måten en brytende endring lanseres på.

De åtte offisielle SDK-ene følger API-et: et nytt endepunkt er en minor SDK-utgivelse, et fjernet eller omdøpt endepunkt en major-utgivelse.

Hva som regnes som brytende

Dette skjer aldri innenfor en stiversjon:

Å fjerne eller døpe om et endepunkt, en spørringsparameter eller et responsfelt.
Å endre et felts type, eller regelen om at priser, kurser og tilbud er desimalstrenger.
Å endre { data, meta }-konvolutten, feilkonvolutten eller betydningen av en eksisterende feilkode.
Å senke en kallgrense eller kvote en plan allerede har.

Dette kan skje når som helst og kunngjøres i endringsloggen:

Nye endepunkter, spørringsparametere og responsfelt.
Nye feilkoder for nye situasjoner - match alltid på error.code, aldri på meldingen.
Nye verdier i lister referansen sier kan vokse, som hendelsesnavn og indikatornavn.
Høyere grenser og kvoter.

Utfasing

Når et endepunkt, en parameter eller et felt planlegges fjernet, kunngjøres det i endringsloggen og på e-post til hver nøkkeleier, og fra den dagen svarer endepunktet med Deprecation- og Sunset-headere (RFC 9745, RFC 8594) som oppgir fjerningsdatoen. OpenAPI-kontrakten flagger det med deprecated: true.

Fjerning skjer tidligst seks måneder etter kunngjøringen. En ny stiversjon kjører side om side med den forrige i minst seks måneder før den gamle fases ut på samme måte.

Ingenting er for øyeblikket utfaset eller planlagt fjernet.

Grenser og rimelig bruk

Burst-grenser per minutt og månedlige kvoter er en del av planen din, rapporteres på hvert svar i X-RateLimit-*- og X-Quota-*-headerne og er dokumentert i referansen. Å heve en grense er aldri brytende; å senke en innenfor en plan er det, og følger tidslinjen for utfasing.

Ansvarlig avsløring

Mener du at du har funnet en sikkerhetssårbarhet i bitculator.com, Data API-et, MCP-serveren eller SDK-ene, send en e-post til contact@bitculator.com med berørt URL eller endepunkt, trinn for å reprodusere og konsekvensen du ser. Du får svar innen tre virkedager.

Hold rapporten privat til problemet er rettet, ikke få tilgang til eller endre data som ikke er dine, og ikke kjør tjenestenektangrep eller automatisert skanning mot produksjon. Rapporter levert i god tro på disse vilkårene vil ikke bli møtt med rettslige skritt. Det finnes ikke noe betalt bounty-program; kreditering gis på forespørsel.

Samme kontakt publiseres maskinlesbart på /.well-known/security.txt (RFC 9116).

Status og hendelser

Live komponentstatus, åpne hendelser og de siste 30 dagenes nedetid finnes på statussiden og på /status.json.