Pular para o conteúdo

Autenticação

Toda chamada à API usa um token de API no header Authorization, no formato Bearer. O token começa com pk_, pertence a uma organização e dá acesso a toda a superfície pública da API daquela organização.

Authorization: Bearer pk_seu_token_aqui

Você precisa de Criar e rotacionar tokens de API. Administradores recebem essa capacidade por padrão, e funções personalizadas podem recebê-la separadamente.

  1. Abra Configurações pelo menu do avatar e selecione Desenvolvedores → API. O endereço direto é /settings/api.

  2. Na aba Tokens, clique em Gerar Token API.

  3. Informe um Nome do Token, como n8n produção ou backend interno, e clique em Gerar Token.

  4. Em Token Gerado, copie o valor imediatamente. Ele é exibido uma única vez; o SquadOS armazena somente o hash e o prefixo.

Se fechar o diálogo ou perder o valor, não há recuperação. Gere outro token, atualize a integração e revogue o anterior.

A base de produção é https://api.squados.io/v1. Inclua o header em toda requisição e use Content-Type: application/json quando houver corpo:

Terminal window
curl https://api.squados.io/v1/agents \
-H "Authorization: Bearer pk_seu_token_aqui"
Terminal window
curl -X POST https://api.squados.io/v1/chat/AGENT_ID \
-H "Authorization: Bearer pk_seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{"message":"Olá!","sync":true}'

O token determina a organização da chamada. IDs de outra organização não ficam acessíveis com essa credencial.

A tabela em API → Tokens mostra nome, prefixo, status, criação, último uso e quantidade de chamadas. O valor secreto completo nunca reaparece.

  • Visualizar tokens de API permite abrir e consultar a tabela.
  • Criar e rotacionar tokens de API permite gerar e revogar.
  • Excluir tokens de API permite apagar definitivamente um registro.

Revogar token interrompe a autenticação e preserva a linha como Revogado. Excluir token remove a linha após confirmação. Tokens revogados não podem ser reativados.

Token ausente, malformado, inválido ou revogado retorna 401:

{
"error": "Invalid or missing API token",
"code": "unauthorized"
}

Confira o espaço depois de Bearer, o prefixo pk_ e se o token continua Ativo. A interface atual não configura expiração automática. Veja Erros para o contrato completo.