Autentikasi & Kunci API

API Publik menggunakan kunci API Bearer dengan awalan spk_.

Authorization: Bearer spk_...

Lingkup Merek

Setiap kunci API dicakupkan ke satu merek. Merek yang ditargetkan oleh endpoint /v1/brand/* ditentukan oleh kunci itu sendiri, sehingga Anda tidak dapat menentukan merek lain dalam body permintaan.

Hanya pemilik merek yang dapat membuat dan mengeluarkan kunci API.

Cakupan & Izin

Tergantung pada titik akhirnya, cakupan berikut akan diperiksa:

brands:read, brands:write
connections:read
publishing:read, publishing:write
comments:read, comments:write, comments:moderate
analytics:read
webhooks:read, webhooks:write

Jika kunci API tidak memiliki cakupan yang diperlukan, server akan mengembalikan 403 insufficient_scope.

Titik Akhir Tanpa Autentikasi

/
/v1/health
/v1/docs
/v1/openapi.json

Kuota Paket

Merek dengan paket Gratis diizinkan memiliki 1 kunci API aktif dan 1.000 permintaan API terhitung per bulan kalender (UTC). Merek dengan paket Growth mendukung banyak kunci aktif dan beroperasi di bawah kebijakan penggunaan wajar.

Baik permintaan yang berhasil maupun yang gagal yang dibuat setelah autentikasi valid akan dihitung ke dalam kuota Gratis. Pemeriksaan kesehatan, dokumentasi API, permintaan skema OpenAPI, dan permintaan kunci yang tidak valid dikecualikan dari perhitungan jumlah.

Rekomendasi Keamanan

Simpan kunci dalam variabel lingkungan atau layanan manajemen rahasia.
Jangan pernah menyertakan kunci dalam kode browser sisi klien.
Samarkan kunci dalam output pencatatan (logging).
Nonaktifkan kunci yang tidak digunakan dan rotasi dengan kunci baru.
Pisahkan kunci per skrip otomatis untuk membedakan log akses.