Bitculator

Kebijakan

Kebijakan API

Cara Data API diberi versi, cara penghentian diumumkan dan berapa lama berlangsung, serta cara melaporkan masalah keamanan.

Pemversian

API diberi versi lewat path: setiap endpoint berada di bawah /api/v1. info.version kontrak (saat ini 1.1.0) mengikuti log perubahan: nomor minor naik saat ada yang ditambahkan, nomor patch saat ada yang diperbaiki, dan versi path baru (/api/v2) adalah satu-satunya cara sebuah breaking change dirilis.

Delapan SDK resmi mengikuti API: endpoint baru berarti rilis minor SDK, endpoint yang dihapus atau diganti namanya berarti rilis major.

Apa yang dihitung sebagai breaking

Hal-hal berikut tidak pernah terjadi di dalam satu versi path:

  • Menghapus atau mengganti nama endpoint, parameter query, atau field respons.
  • Mengubah tipe sebuah field, atau aturan bahwa harga, kurs, dan suplai adalah string desimal.
  • Mengubah envelope { data, meta }, envelope error, atau makna kode error yang sudah ada.
  • Menurunkan rate limit atau kuota yang sudah dimiliki sebuah paket.

Hal-hal berikut bisa terjadi kapan saja dan diumumkan di log perubahan:

  • Endpoint, parameter query, dan field respons baru.
  • Kode error baru untuk situasi baru - selalu cocokkan pada error.code, jangan pernah pada pesannya.
  • Nilai baru dalam daftar yang menurut referensi bisa bertambah, seperti nama event dan nama indikator.
  • Batas dan kuota yang lebih tinggi.

Penghentian

Saat sebuah endpoint, parameter, atau field dijadwalkan untuk dihapus, hal itu diumumkan di log perubahan dan lewat email ke setiap pemilik key, dan sejak hari itu endpoint tersebut menjawab dengan header Deprecation dan Sunset (RFC 9745, RFC 8594) yang menyebutkan tanggal penghapusannya. Kontrak OpenAPI menandainya dengan deprecated: true.

Penghapusan dilakukan paling cepat enam bulan setelah pengumuman. Versi path baru berjalan berdampingan dengan versi sebelumnya selama setidaknya enam bulan sebelum versi lama dihentikan dengan cara yang sama.

Saat ini tidak ada yang dihentikan atau dijadwalkan untuk dihapus.

Batas dan penggunaan wajar

Batas burst per menit dan kuota bulanan adalah bagian dari paket Anda, dilaporkan pada setiap respons di header X-RateLimit-* dan X-Quota-*, dan didokumentasikan di referensi. Menaikkan batas tidak pernah bersifat breaking; menurunkannya di dalam sebuah paket bersifat breaking dan mengikuti linimasa penghentian.

Pengungkapan bertanggung jawab

Jika Anda yakin telah menemukan kerentanan keamanan di bitculator.com, Data API, server MCP, atau SDK, kirim email ke contact@bitculator.com dengan URL atau endpoint yang terdampak, langkah-langkah untuk mereproduksinya, dan dampak yang Anda lihat. Anda akan menerima balasan dalam tiga hari kerja.

Mohon rahasiakan laporan sampai masalahnya diperbaiki, jangan mengakses atau mengubah data yang bukan milik Anda, dan jangan menjalankan denial-of-service atau pemindaian otomatis terhadap produksi. Laporan yang dibuat dengan iktikad baik berdasarkan ketentuan ini tidak akan ditanggapi dengan tindakan hukum. Tidak ada program bounty berbayar; kredit diberikan atas permintaan.

Kontak yang sama diterbitkan dalam bentuk yang dapat dibaca mesin di /.well-known/security.txt (RFC 9116).

Status dan insiden

Status komponen live, insiden terbuka, dan gangguan 30 hari terakhir tersedia di halaman status dan di /status.json.