Політики

Політики API

Як версіонується Data API, як оголошується застарівання та скільки воно триває, і як повідомити про проблему безпеки.

Версіонування

API версіонується у шляху: кожен ендпоінт живе під /api/v1. info.version контракту (зараз 1.1.0) відповідає журналу змін: мінорний номер зростає, коли щось додано, патч-номер - коли щось виправлено, а нова версія шляху (/api/v2) - єдиний спосіб випустити несумісну зміну.

Вісім офіційних SDK слідують за API: новий ендпоінт - мінорний реліз SDK, видалений чи перейменований - мажорний.

Що вважається несумісною зміною

Усередині однієї версії шляху цього ніколи не трапляється:

Видалення або перейменування ендпоінта, параметра запиту чи поля відповіді.
Зміна типу поля або правила, за яким ціни, курси та обсяги пропозиції є десятковими рядками.
Зміна оболонки { data, meta }, оболонки помилок або значення наявного коду помилки.
Зниження ліміту запитів чи квоти, які тариф уже має.

Це може статися будь-коли й оголошується в журналі змін:

Нові ендпоінти, параметри запиту та поля відповіді.
Нові коди помилок для нових ситуацій - завжди звіряйтеся з error.code, а не з текстом повідомлення.
Нові значення у списках, які за довідником можуть розширюватися, наприклад назви подій та індикаторів.
Підвищення лімітів і квот.

Застарівання

Коли ендпоінт, параметр або поле заплановано до видалення, про це оголошується в журналі змін та електронною поштою кожному власнику ключа, і з того дня ендпоінт відповідає заголовками Deprecation і Sunset (RFC 9745, RFC 8594) із датою видалення. У контракті OpenAPI його позначено deprecated: true.

Видалення відбувається не раніше ніж через шість місяців після оголошення. Нова версія шляху працює паралельно з попередньою щонайменше шість місяців, перш ніж стару буде виведено з експлуатації в той самий спосіб.

Наразі ніщо не застаріло й не заплановано до видалення.

Ліміти та добросовісне використання

Хвилинні ліміти та місячні квоти - частина вашого тарифу; вони повідомляються в кожній відповіді в заголовках X-RateLimit-* і X-Quota-* та задокументовані в довіднику. Підвищення ліміту ніколи не є несумісною зміною; зниження всередині тарифу - є, і відбувається за графіком застарівання.

Відповідальне розкриття

Якщо ви вважаєте, що знайшли вразливість у bitculator.com, Data API, MCP-сервері чи SDK, напишіть на contact@bitculator.com, вказавши уражений URL чи ендпоінт, кроки відтворення та вплив, який ви спостерігаєте. Ми відповімо протягом трьох робочих днів.

Будь ласка, не розголошуйте звіт до виправлення, не отримуйте доступ до чужих даних і не змінюйте їх, не проводьте DoS-атак чи автоматичного сканування проти продакшену. До добросовісних звітів на цих умовах юридичні заходи не застосовуються. Платної програми винагород немає; на запит указуємо авторство.

Той самий контакт опубліковано в машинозчитуваному вигляді за адресою /.well-known/security.txt (RFC 9116).

Статус та інциденти

Поточний статус компонентів, відкриті інциденти та збої за останні 30 днів - на сторінці статусу та за адресою /status.json.