Bitculator

Politici

Politicile API

Cum este versionat API-ul de date, cum sunt anunțate retragerile din uz și cât timp durează ele și cum raportați o problemă de securitate.

Versionare

API-ul este versionat în cale: fiecare endpoint se află sub /api/v1. Câmpul info.version din contract (în prezent 1.3.1) urmează jurnalul de modificări: numărul minor crește când se adaugă ceva, numărul de patch când se repară ceva, iar o nouă versiune din cale (/api/v2) este singura cale prin care poate apărea o modificare incompatibilă.

Cele opt SDK-uri oficiale urmăresc API-ul: un endpoint nou înseamnă o versiune minoră de SDK, iar unul eliminat sau redenumit înseamnă o versiune majoră.

Ce înseamnă o modificare incompatibilă

Acestea nu se întâmplă niciodată în interiorul unei versiuni din cale:

  • Eliminarea sau redenumirea unui endpoint, a unui parametru de interogare ori a unui câmp din răspuns.
  • Modificarea tipului unui câmp sau a regulii conform căreia prețurile, cursurile și ofertele sunt șiruri zecimale.
  • Modificarea structurii { data, meta }, a structurii de eroare sau a înțelesului unui cod de eroare existent.
  • Reducerea unei limite de rată ori a unei cote pe care un abonament le are deja.

Acestea pot apărea oricând și sunt anunțate în jurnalul de modificări:

  • Endpointuri, parametri de interogare și câmpuri de răspuns noi.
  • Coduri de eroare noi pentru situații noi - potriviți întotdeauna după error.code, niciodată după mesaj.
  • Valori noi în listele despre care referința spune că pot crește, precum numele de evenimente și numele de indicatori.
  • Limite și cote mai mari.

Retragerea din uz

Când un endpoint, un parametru sau un câmp este programat pentru eliminare, acest lucru este anunțat în jurnalul de modificări și prin e-mail către fiecare deținător de cheie, iar din acea zi endpointul răspunde cu antetele Deprecation și Sunset (RFC 9745, RFC 8594), care indică data eliminării. Contractul OpenAPI îl marchează cu deprecated: true.

Eliminarea are loc cel mai devreme la șase luni după anunț. O nouă versiune din cale funcționează în paralel cu cea anterioară timp de cel puțin șase luni, înainte ca versiunea veche să fie retrasă în același fel.

În prezent nimic nu este retras din uz și nimic nu este programat pentru eliminare.

Limite și utilizare corectă

Limitele de vârf pe minut și cotele lunare fac parte din abonamentul dumneavoastră, sunt raportate la fiecare răspuns în antetele X-RateLimit-* și X-Quota-* și sunt documentate în referință. Creșterea unei limite nu este niciodată o modificare incompatibilă; reducerea uneia în interiorul unui abonament este și urmează calendarul de retragere din uz.

Raportare responsabilă

Dacă credeți că ați descoperit o vulnerabilitate de securitate în bitculator.com, în API-ul de date, în serverul MCP sau în SDK-uri, scrieți la contact@bitculator.com și indicați URL-ul ori endpointul afectat, pașii de reproducere și impactul pe care îl vedeți. Veți primi un răspuns în termen de trei zile lucrătoare.

Vă rugăm să păstrați raportul confidențial până la remediere, să nu accesați și să nu modificați date care nu vă aparțin și să nu rulați atacuri de tip denial-of-service ori scanări automate asupra mediului de producție. Rapoartele făcute cu bună-credință în aceste condiții nu vor fi urmate de acțiuni în justiție. Nu există un program de recompense plătite; menționăm autorul la cerere.

Aceleași date de contact sunt publicate în format citibil automat la /.well-known/security.txt (RFC 9116).

Stare și incidente

Starea în timp real a componentelor, incidentele deschise și întreruperile din ultimele 30 de zile se găsesc pe pagina de stare și la /status.json.