Autentikasi
API CoinBoss bersifat publik. Anda tidak memerlukan akun atau kunci API untuk memanggil endpoint data mana pun.
Tanpa kunci
Panggil endpoint mana pun di katalog dengan HTTPS GET biasa. Permintaan anonim dibatasi per alamat IP: 1200 permintaan per menit.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Kunci API opsional
Jika beberapa layanan Anda berbagi satu alamat IP, atau Anda memanggil dari jaringan yang alamatnya berubah-ubah, Anda dapat membuat kunci di akun Anda dan mengirimkannya dalam header CB-API-KEY. Permintaan dengan kunci yang valid dihitung terhadap kunci tersebut, bukan terhadap alamat IP.
- Kunci dibuat dan dicabut di halaman kunci API pada akun Anda. Alamat email yang terverifikasi diperlukan.
- Kunci lengkap hanya ditampilkan sekali, saat dibuat. Yang disimpan hanya hash-nya, sehingga kunci tidak dapat ditampilkan lagi.
- Setiap akun dapat memiliki hingga lima kunci aktif.
- Kunci yang tidak dikenal atau sudah dicabut akan diabaikan: permintaan dilayani sebagai anonim dan dihitung terhadap alamat IP.
Permintaan dengan kunci
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Tingkatan batas permintaan
Semua tingkatan mengembalikan data yang sama. Selama periode gratis saat ini, trafik anonim dan setiap kunci dilayani pada tingkatan tertinggi.
| Tingkatan | Permintaan per menit | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | berlaku untuk semua saat ini |
Menjaga keamanan kunci
- Perlakukan kunci seperti kata sandi. Simpan di variabel lingkungan atau secret store, bukan di kode sumber.
- Jangan menyematkan kunci di halaman web, ekstensi browser, atau aplikasi seluler. Apa pun yang dikirim ke klien dapat dibaca oleh penggunanya. Panggil API dari server Anda, atau panggil secara anonim dari browser.
- Cabut kunci begitu Anda mencurigai kunci itu bocor, lalu buat yang baru.
- CoinBoss tidak pernah meminta kunci API bursa. Data dikumpulkan dari endpoint publik bursa, dan API ini tidak memerlukan maupun menerima kredensial bursa apa pun.
Memanggil dari browser
Respons menyertakan Access-Control-Allow-Origin: *, sehingga endpoint data dapat dipanggil dari origin web mana pun. Header X-Request-Id, X-Cache, dan X-RateLimit-* diekspos ke skrip.
Endpoint akun
Endpoint di bawah /api/user dan /api/auth merupakan bagian dari pengalaman situs web setelah masuk (watchlist, preferensi, pengelolaan kunci). Endpoint tersebut memakai sesi situs, bukan bagian dari API data publik, dan tidak tercantum di katalog.