Terakhir diperbarui
Autentikasi
Setiap permintaan membawa API key workspace sebagai Bearer token. Key memiliki scope, dapat dicabut, dan terikat pada dompet kredit satu workspace.
Bearer key
Kirim key di header Authorization sebagai Bearer <key>. Key berbentuk ttk_live_<id>_<secret>; dashboard menampilkannya berdasarkan prefix ttk_live_<id>. Buat key di Settings → API keys; key lengkap hanya ditampilkan sekali. Sebuah key bertindak atas nama pemilik workspace, terbatas pada scope-nya.
curl "https://api.toktokdata.live/v1/rankings/regions" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Scope
Sebuah key hanya dapat memanggil endpoint yang tercakup oleh scope-nya. Pilih kumpulan scope terkecil yang cukup untuk pekerjaannya; Anda selalu bisa membuat key kedua. Permintaan di luar scope key, serta route khusus dashboard (daftar pantauan, room, workspace, penagihan), mengembalikan 403 dengan kode insufficient_scope; paket tanpa modul yang bersangkutan mengembalikan module_not_entitled.
| Scope | Memberi akses ke |
|---|---|
live:read | Sesi LIVE, satu sesi, performa kreator, dan refresh live. Memerlukan modul LIVE. |
rank:read | Papan peringkat resmi, wilayah, dan riwayat papan. Memerlukan modul LIVE. |
shop:read | Juga diperlukan untuk papan shopping (board yang diawali shopping). |
creator:read | Pencarian kreator, profil, analisis, perubahan, following, pengikut, dan insight. Memerlukan modul Pencarian. |
content:read | Video, komentar video, dan video milik seorang kreator. Memerlukan modul Pencarian. |
trend:read | Tren regional. Memerlukan modul Pencarian. |
export | Membuat, menampilkan daftar, dan mengunduh ekspor. |
webhook:manage | Aturan peringatan di setiap kanal, dan uji aturan. Memerlukan modul LIVE. |
keys:manage | Menampilkan daftar, membuat, dan mencabut API key; membaca hak akses dan pemakaian. |
live:stream · gifter:read | Dicadangkan untuk endpoint mendatang; saat ini belum memberi akses apa pun. |
Rotasi key
Buat key pengganti terlebih dahulu, deploy, lalu cabut key lama dari layar yang sama. Pencabutan berlaku seketika: permintaan yang sedang berjalan tetap selesai, permintaan baru gagal dengan 401.
Key juga dapat dibuat dengan tanggal expiresAt; setelah tanggal itu key akan menjawab 401.
Error
| Status | Kode | Arti |
|---|---|---|
| 401 | unauthorized | Key tidak ada, formatnya salah, sudah dicabut atau kedaluwarsa, atau workspace tidak aktif. |
| 403 | insufficient_scope | Key valid tetapi tidak memiliki scope tersebut, atau route-nya khusus dashboard. |
| 403 | module_not_entitled | Paket workspace tidak mencakup modul LIVE atau Pencarian. |
| 402 | credit_cap_exceeded | Kredit bulan ini sudah habis. Lihat Kredit dan Error. |