Authentifizierung, Scopes & Tarife
API-Schlüssel
Senden Sie Ihren Schlüssel auf eine von drei Arten, die an jedem REST-Endpunkt und am WebSocket gleich akzeptiert werden: Authorization: Bearer xsf_…, der Header X-API-Key oder ?api_key= in der URL (für Browser gedacht, die beim WebSocket-Handshake keine Header setzen können). Senden Sie mehrere, wird zuerst Authorization verwendet, dann X-API-Key, dann api_key. Ein nicht existierender und ein widerrufener Schlüssel werden unterschieden: invalid_api_key heißt, auf Tippfehler oder ein altes Secret prüfen; key_revoked heißt, sich an den Aussteller wenden.
Scopes
Ein Schlüssel trägt Berechtigungen (Scopes). Ein Aufruf außerhalb davon liefert 403 mit {"error":{"code":"scope_required"}} und nennt die fehlende Berechtigung. GET /v1/account listet Ihre; GET /v1/meta/scopes listet alle.
| Scope | Was er erlaubt |
|---|---|
| targets:read | Die von diesem Schlüssel überwachten Konten auflisten |
| targets:write | Überwachte Konten hinzufügen, ändern und entfernen, einzeln oder in Batches |
| keywords:read | Stichwörter auflisten und search.match-Ereignisse empfangen |
| keywords:write | Stichwörter hinzufügen und entfernen |
| stream | Den WebSocket öffnen |
| replay | last_id und GET /v1/events verwenden |
| webhook | Webhook-Zustellung konfigurieren |
| reads | REST-Lesezugriffe auf Abruf auf Profile, Beiträge, Follower und gefolgte Konten; kostet Guthaben |
Administrative Berechtigungen existieren für unsere eigenen Betreiber und werden über eine separate, private Schnittstelle bereitgestellt. Ein Kundenschlüssel kann nie eine davon tragen.
Tarife
Ein Tarif ist eine Voreinstellung aus Berechtigungen und Obergrenzen; jeder Schlüssel kann individuell angepasst werden. Die aktuelle Matrix finden Sie unter GET /v1/meta/plans. Preise werden hier nicht veröffentlicht.
| Tarif | Ziele | Stichwörter | Verbindungen | Anfragen / min | Scopes |
|---|---|---|---|---|---|
| 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 |