Autenticação: chaves de API

A API usa chaves de API do workspace, que começam com xsk_. Cada chave tem um nome, vale só no workspace em que foi criada e só para os escopos que você marcar.

Criar a chaveCopy Anchor Link

1. Na XBASE, abra Integrações e vá à aba Agentes & APIs. É preciso ter permissão para gerenciar integrações.
2. No card Chaves de API, clique em Nova chave (ou em Conectar Integração, se for a primeira).
3. Em Nome, escreva quem vai usar a chave, como "ERP da loja".
4. Em Permissões, marque só o que a integração precisa (escopos).
5. Clique em Criar chave. A janela Chave criada mostra a chave inteira uma única vez: copie e guarde num cofre de senhas.
6. Clique em Pronto, já copiei.

Usar a chaveCopy Anchor Link

Mande a chave no cabeçalho Authorization. Para conferir se ela funciona, chame GET /me:

curl https://api.xbase.app/api/external/v1/me \
  -H "Authorization: Bearer $XBASE_API_KEY"

Resposta 200:

{
  "workspace": { "id": "8f0c2d4e-…", "name": "Minha empresa" },
  "key": { "id": "3b1e9a77-…", "name": "ERP da loja", "scopes": ["whatsapp:send"] }
}

Guarde a chave numa variável de ambiente ou num cofre de segredos, nunca no código do site ou do aplicativo.

Revogar e trocar a chaveCopy Anchor Link

No card Chaves de API, cada chave aparece com os 4 últimos caracteres, a data de criação e o último uso. Clique em Revogar para cortar o acesso na hora. Revogar também desliga o webhook da chave.

Para trocar uma chave sem parar a integração: crie a nova, atualize o sistema que a usa e só então revogue a antiga.

Erros de autenticaçãoCopy Anchor Link

Exemplo:

{
  "statusCode": 401,
  "timestamp": "2026-11-04T16:03:56.074Z",
  "path": "/api/external/v1/me",
  "method": "GET",
  "message": "Chave de API inválida ou revogada.",
  "code": "INVALID_API_KEY"
}

Perguntas frequentesCopy Anchor Link

Veja tambémCopy Anchor Link