Kimlik doğrulama, kapsamlar & planlar
API anahtarları
Anahtarınızı üç yoldan biriyle gönderin; tüm REST uç noktalarında ve WebSocket'te aynı şekilde kabul edilir: Authorization: Bearer xsf_…, X-API-Key başlığı ya da URL'de ?api_key= (WebSocket el sıkışmasında başlık ayarlayamayan tarayıcılar için). Birden fazlasını gönderirseniz önce Authorization, sonra X-API-Key, sonra api_key kullanılır. Var olmayan bir anahtar ile iptal edilmiş bir anahtar ayırt edilir: invalid_api_key yazım hatası ya da eski bir gizli anahtarı kontrol edin demektir; key_revoked ise anahtarı verene başvurun demektir.
Kapsamlar
Bir anahtar kapsamlar taşır. Kapsam dışı bir çağrı, eksik olan kapsamı adlandıran {"error":{"code":"scope_required"}} ile 403 döner. GET /v1/account sizinkileri listeler; GET /v1/meta/scopes hepsini listeler.
| Kapsam | Neye izin verir |
|---|---|
| targets:read | Bu anahtarın izlediği hesapları listele |
| targets:write | İzlenen hesapları tek tek veya toplu olarak ekle, değiştir ve kaldır |
| keywords:read | Anahtar kelimeleri listele ve search.match olaylarını al |
| keywords:write | Anahtar kelime ekle ve kaldır |
| stream | WebSocket'i aç |
| replay | last_id ve GET /v1/events kullan |
| webhook | Webhook teslimatını yapılandır |
| reads | Profillerin, gönderilerin, takipçilerin ve takip edilenlerin isteğe bağlı REST okumaları; kredi harcar |
Yönetimsel kapsamlar kendi operatörlerimiz için vardır ve ayrı, özel bir arayüzden sunulur. Bir müşteri anahtarı asla böyle bir kapsam taşıyamaz.
Planlar
Plan, kapsamlar ve üst sınırlardan oluşan bir ön ayardır; her anahtar tek tek ayarlanabilir. Güncel matris GET /v1/meta/plans adresindedir. Fiyatlar burada yayımlanmaz.
| Plan | Hedefler | Anahtar kelimeler | Bağlantılar | İstek / dk | Kapsamlar |
|---|---|---|---|---|---|
| starter | 50 | 0 | 2 | 300 | targets:read, targets:write, stream, replay, reads, webhook |
| pro | 200 | 20 | 5 | 600 | targets:read, targets:write, stream, replay, reads, webhook, keywords:read, keywords:write |
| scale | 1000 | 100 | 10 | 900 | targets:read, targets:write, keywords:read, keywords:write, stream, replay, webhook, reads |
| ultra | 2000 | 300 | 20 | 1200 | targets:read, targets:write, keywords:read, keywords:write, stream, replay, webhook, reads |