Autentikasi dan batasan

Kunci API

Pemilik dan admin membuat kunci di Developer pada konsol. Sebuah kunci berbentuk sr_live_ diikuti 32 karakter dan hanya ditampilkan sekali; kami hanya menyimpan hash SHA-256-nya. Kirim kunci di header Authorization:

Authorization: Bearer sr_live_…

Sebuah kunci milik satu ruang kerja dan bertindak atas nama seluruh ruang kerja tersebut — semua situs, seperti admin yang melayani semuanya — jadi tidak ada header ruang kerja. Simpan kunci di server Anda, jangan pernah di halaman web atau aplikasi. Cabut kunci di konsol dan kunci langsung berhenti berfungsi. Kunci juga dicabut saat rekan tim yang membuatnya keluar dari ruang kerja, dinonaktifkan, atau diubah menjadi agen, jadi buat kunci dari akun yang akan tetap ada.

Scope

Setiap kunci hanya memiliki scope yang Anda centang. Panggilan tanpa scope yang diperlukan mendapat 403 forbidden dengan error.fields.scope yang menyebutkan scope tersebut.

Scope	Mengizinkan
conversations:read	GET /v1/conversations, GET /v1/conversations/{id}
conversations:write	POST …/assign, POST …/close
messages:read	GET /v1/conversations/{id}/messages, GET /v1/offline-messages
messages:write	POST /v1/conversations/{id}/messages
visitors:read	GET /v1/visitors/{id}
visitors:write	PATCH /v1/visitors/{id}
members:read	GET /v1/members
visitors:export	POST /v1/visitors/lookup, GET /v1/visitors/{id}/export (permintaan data)
visitors:delete	DELETE /v1/visitors/{id} (permintaan data)
apa pun	GET /v1/usage

Endpoint lain (situs, tim, tagihan, kunci itu sendiri) hanya untuk konsol dan menolak kunci.

Mengirim pesan

POST /v1/conversations/{id}/messages mengirim:

• sebagai integrasi Anda secara bawaan: pesan tampil berasal dari situs Anda (bagi pengunjung) dan sebagai Integrasi (bagi agen). Pesan ini tidak mengambil percakapan dari antrean, jadi cocok untuk bot dan balasan otomatis. Hanya teks.
• sebagai agen dengan "member_id": "…": pesan berasal dari agen tersebut, dan seperti balasan agen lainnya, pesan ini mengambil percakapan yang sedang menunggu — jadi kunci juga memerlukan conversations:write.

Batasan

Batasan	Nilai	Jika terlampaui
Request per kunci	20 per detik	429 rate_limited dengan Retry-After
Request per ruang kerja	50 per detik, semua kunci digabung	429 rate_limited dengan Retry-After
Panggilan API per ruang kerja	Kuota bulanan paket Anda (bulan UTC, semua kunci digabung)	402 quota_exceeded, fields.limit = api_calls_per_month
Kunci aktif	20 per ruang kerja	402 quota_exceeded, fields.limit = api_keys

GET /v1/usage menampilkan panggilan bulan ini dibandingkan kuotanya. Panggilan yang ditolak tidak dihitung. Paket tanpa panggilan API (Gratis) tidak bisa membuat kunci.