Son güncelleme
Kimlik doğrulama
Her istek, Bearer token olarak bir çalışma alanı API anahtarı taşır. Anahtarlar kapsamlıdır, iptal edilebilir ve tek bir çalışma alanının kredi cüzdanına bağlıdır.
Bearer anahtarları
Anahtarı Authorization başlığında Bearer <key> olarak gönderin. Anahtarlar ttk_live_<id>_<secret> biçimindedir; panel onları ttk_live_<id> önekiyle listeler. Anahtarları Ayarlar → API anahtarları altında oluşturun; anahtarın tamamı yalnızca bir kez gösterilir. Bir anahtar, kapsamlarıyla sınırlı olarak çalışma alanı sahibi adına işlem yapar.
curl "https://api.toktokdata.live/v1/rankings/regions" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Kapsamlar
Bir anahtar yalnızca kapsamlarının kapsadığı endpoint’leri çağırabilir. İşi gören en küçük kümeyi seçin; her zaman ikinci bir anahtar oluşturabilirsiniz. Anahtarın kapsamları dışındaki istekler ve yalnızca panele açık rotalar (takip listesi, odalar, çalışma alanı, faturalandırma), insufficient_scope koduyla 403 döndürür; modülü içermeyen bir plan ise module_not_entitled döndürür.
| Kapsam | Verdiği erişim |
|---|---|
live:read | LIVE oturumları, tek bir oturum, içerik üreticisi performansı ve canlı yenileme. LIVE modülü gerekir. |
rank:read | Resmî sıralama tabloları, bölgeler ve sıralama geçmişi. LIVE modülü gerekir. |
shop:read | Alışveriş sıralamaları için ek olarak gerekir (board, shopping ile başlıyorsa). |
creator:read | İçerik üreticisi arama, profiller, analiz, değişiklikler, takip edilenler, takipçiler ve içgörüler. Sorgulama modülü gerekir. |
content:read | Videolar, video yorumları ve bir içerik üreticisinin videoları. Sorgulama modülü gerekir. |
trend:read | Bölgesel trendler. Sorgulama modülü gerekir. |
export | Dışa aktarma oluşturma, listeleme ve indirme. |
webhook:manage | Tüm kanallardaki uyarı kuralları ve kural testleri. LIVE modülü gerekir. |
keys:manage | API anahtarlarını listeleme, oluşturma ve iptal etme; plan haklarını ve kullanımı okuma. |
live:stream · gifter:read | Yakında gelecek endpoint’ler için ayrılmıştır; şimdilik hiçbir yetki vermez. |
Anahtar yenileme
Önce yerine geçecek anahtarı oluşturun ve devreye alın, ardından eskisini aynı ekrandan iptal edin. İptal anında geçerli olur: sürmekte olan istekler tamamlanır, yeni istekler 401 ile başarısız olur.
Anahtarlar bir expiresAt tarihiyle de oluşturulabilir; bu tarihten sonra 401 döndürürler.
Hatalar
| Durum | Kod | Anlamı |
|---|---|---|
| 401 | unauthorized | Eksik, hatalı biçimli, iptal edilmiş veya süresi dolmuş anahtar ya da etkin olmayan bir çalışma alanı. |
| 403 | insufficient_scope | Anahtar geçerli ancak gereken kapsama sahip değil ya da rota yalnızca panele açık. |
| 403 | module_not_entitled | Çalışma alanının planı LIVE veya Sorgulama modülünü içermiyor. |
| 402 | credit_cap_exceeded | Bu ayın kredileri tükendi. Krediler ve Hatalar sayfalarına bakın. |