Autenticação

Toda requisição precisa levar a sua chave de API. Envie-a no cabeçalho Authorization como bearer token, ou no cabeçalho X-Api-Key se o seu cliente não conseguir definir o Authorization.

Cabeçalhos#

Authorization: Bearer xca_live_…
# or
X-Api-Key: xca_live_…

curl -s "https://app.xca.fun/api/v1/new-pairs?limit=5" \
  -H "X-Api-Key: $XCA_API_KEY"

Formato da chave#

As chaves começam com xca_live_, seguido de uma string aleatória em base58. O XCA guarda apenas um hash da chave, então uma chave perdida não pode ser recuperada: crie uma nova.

Mantenha as chaves em sigilo#

• Chame a API a partir do seu servidor ou bot, nunca de uma página web pública ou do pacote de um app mobile.
• Não faça commit de chaves em repositórios; carregue-as de variáveis de ambiente ou de um gerenciador de segredos.
• Use uma chave separada para cada projeto, assim você pode revogar uma sem afetar as outras.
• Chaves revogadas param de funcionar imediatamente.

Rotação de chave#

Crie uma nova chave, faça o deploy dela, confira se as requisições são bem-sucedidas e depois revogue a antiga na página API.

Erros de autenticação#

Uma chave ausente, malformada ou revogada retorna 401 unauthorized. Uma chave válida em um plano sem acesso à API retorna 402 planRequired.

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}