Authentification, portées & offres
Clés d'API
Envoyez votre clé de l'une des trois façons, acceptées de la même manière sur tous les endpoints REST et sur le WebSocket : Authorization: Bearer xsf_…, l'en-tête X-API-Key, ou ?api_key= dans l'URL (prévu pour les navigateurs, qui ne peuvent pas définir d'en-têtes lors du handshake d'un WebSocket). Si vous en envoyez plusieurs, Authorization est utilisé d'abord, puis X-API-Key, puis api_key. Une clé inexistante et une clé révoquée sont distinguées : invalid_api_key signifie vérifier une faute de frappe ou un ancien secret ; key_revoked, s'adresser à qui l'a émise.
Portées
Une clé porte des portées. Un appel en dehors de celles-ci renvoie 403 avec {"error":{"code":"scope_required"}} nommant la portée qui vous manque. GET /v1/account liste les vôtres ; GET /v1/meta/scopes les liste toutes.
| Portée | Ce qu'elle autorise |
|---|---|
| targets:read | Lister les comptes que cette clé surveille |
| targets:write | Ajouter, modifier et retirer des comptes surveillés, un par un ou par lots |
| keywords:read | Lister les mots-clés et recevoir les événements search.match |
| keywords:write | Ajouter et retirer des mots-clés |
| stream | Ouvrir le WebSocket |
| replay | Utiliser last_id et GET /v1/events |
| webhook | Configurer la livraison par webhook |
| reads | Lectures REST à la demande des profils, publications, abonnés, abonnements ; coûte des crédits |
Des portées administratives existent pour nos propres opérateurs et sont servies sur une interface privée distincte. Une clé client ne peut jamais en porter une.
Offres
Une offre est un préréglage de portées et de plafonds ; toute clé peut être ajustée individuellement. La matrice à jour est sur GET /v1/meta/plans. Les prix ne sont pas publiés ici.
| Offre | Cibles | Mots-clés | Connexions | Requêtes / min | Portées |
|---|---|---|---|---|---|
| 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 |