Autentikasi, cakupan & paket

Kunci API

Kirim kunci Anda dengan salah satu dari tiga cara, yang diterima sama di setiap endpoint REST dan di WebSocket: Authorization: Bearer xsf_…, header X-API-Key, atau ?api_key= di URL (untuk browser, yang tidak bisa mengatur header pada handshake WebSocket). Jika Anda mengirim lebih dari satu, Authorization dipakai lebih dulu, lalu X-API-Key, lalu api_key. Kunci yang tidak ada dan kunci yang dicabut dibedakan: invalid_api_key berarti periksa salah ketik atau secret lama; key_revoked berarti hubungi pihak yang menerbitkannya.

Cakupan

Sebuah kunci membawa cakupan. Panggilan di luar cakupan mengembalikan 403 dengan {"error":{"code":"scope_required"}} yang menyebutkan cakupan yang tidak Anda miliki. GET /v1/account mencantumkan cakupan Anda; GET /v1/meta/scopes mencantumkan semuanya.

Cakupan administratif ada untuk operator kami sendiri dan disajikan pada antarmuka privat yang terpisah. Kunci pelanggan tidak pernah bisa membawanya.

Paket

Paket adalah preset cakupan dan batas; setiap kunci bisa disesuaikan secara individual. Matriks terkininya ada di GET /v1/meta/plans. Harga tidak dipublikasikan di sini.