Autenticación, ámbitos & planes
Claves de API
Envía tu clave de una de tres formas, aceptadas igual en todos los endpoints REST y en el WebSocket: Authorization: Bearer xsf_…, la cabecera X-API-Key, o ?api_key= en la URL (pensado para navegadores, que no pueden poner cabeceras en el handshake de un WebSocket). Si envías más de una, se usa primero Authorization, luego X-API-Key y luego api_key. Una clave que no existe y una revocada se distinguen: invalid_api_key significa revisar si hay un error tipográfico o un secreto antiguo; key_revoked, hablar con quien la emitió.
Ámbitos
Una clave lleva ámbitos. Una llamada fuera de ellos devuelve 403 con {"error":{"code":"scope_required"}} indicando el ámbito que te falta. GET /v1/account enumera los tuyos; GET /v1/meta/scopes enumera todos.
| Ámbito | Qué permite |
|---|---|
| targets:read | Enumerar las cuentas que monitoriza esta clave |
| targets:write | Añadir, cambiar y eliminar cuentas monitorizadas, de una en una o por lotes |
| keywords:read | Enumerar palabras clave y recibir eventos search.match |
| keywords:write | Añadir y eliminar palabras clave |
| stream | Abrir el WebSocket |
| replay | Usar last_id y GET /v1/events |
| webhook | Configurar la entrega por webhook |
| reads | Lecturas REST bajo demanda de perfiles, publicaciones, seguidores y seguidos; cuesta créditos |
Existen ámbitos administrativos para nuestros propios operadores y se sirven en una interfaz privada aparte. Una clave de cliente nunca puede llevar uno.
Planes
Un plan es un preajuste de ámbitos y límites; cualquier clave puede ajustarse individualmente. La matriz en vivo está en GET /v1/meta/plans. Los precios no se publican aquí.
| Plan | Objetivos | Palabras clave | Conexiones | Solicitudes / min | Ámbitos |
|---|---|---|---|---|---|
| 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 |