Skip to main content

​
Visão geral

A API utiliza autenticação por chave de API via cabeçalho X-API-Key. As chaves possuem escopos que controlam permissões de leitura e escrita.

​
Como gerar uma chave de API

  1. Navegue até o seu workspace
  2. Clique no icone do usuário > Configurações > Chaves API
  3. Na seção “Chaves API”, clique em ”+ Nova chave API”
  4. Dê um nome para ele e clique em “Criar”
  5. Copie seu token
Generate token

​
Como enviar a chave nas requisições

Adicione o cabeçalho: X-API-Key: ak_xxxxxxxxxxxxxxxxx Exemplo: 
curl -H "X-API-Key: ak_xxxxxxxxx" "${BASE_URL}/v1/integration/projects"

​
Erros comuns de autenticação

  • 401 API_KEY_REQUIRED: cabeçalho ausente ou formato inválido
  • 401 API_KEY_INVALID: chave inexistente ou revogada
  • 403 FORBIDDEN: escopo insuficiente para a operação