Autenticação, escopos & planos
Chaves de API
Envie sua chave de uma de três formas, aceitas igualmente em todos os endpoints REST e no WebSocket: Authorization: Bearer xsf_…, o cabeçalho X-API-Key, ou ?api_key= na URL (pensado para navegadores, que não conseguem definir cabeçalhos no handshake de um WebSocket). Se enviar mais de uma, Authorization é usado primeiro, depois X-API-Key, depois api_key. Uma chave inexistente e uma revogada são distinguidas: invalid_api_key significa conferir erro de digitação ou segredo antigo; key_revoked, falar com quem a emitiu.
Escopos
Uma chave carrega escopos. Uma chamada fora deles retorna 403 com {"error":{"code":"scope_required"}} indicando o escopo que falta. GET /v1/account lista os seus; GET /v1/meta/scopes lista todos.
| Escopo | O que permite |
|---|---|
| targets:read | Listar as contas que esta chave monitora |
| targets:write | Adicionar, alterar e remover contas monitoradas, uma a uma ou em lote |
| keywords:read | Listar palavras-chave e receber eventos search.match |
| keywords:write | Adicionar e remover palavras-chave |
| stream | Abrir o WebSocket |
| replay | Usar last_id e GET /v1/events |
| webhook | Configurar a entrega por webhook |
| reads | Leituras REST sob demanda de perfis, publicações, seguidores e seguindo; consome créditos |
Escopos administrativos existem para os nossos próprios operadores e são servidos em uma interface separada e privada. Uma chave de cliente nunca pode carregar um deles.
Planos
Um plano é uma predefinição de escopos e limites; qualquer chave pode ser ajustada individualmente. A matriz atualizada está em GET /v1/meta/plans. Os preços não são publicados aqui.
| Plano | Contas monitoradas | Palavras-chave | Conexões | Requisições / min | Escopos |
|---|---|---|---|---|---|
| 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 |