Autenticação

Envie X-API-Key

A chave identifica o cliente e limita o acesso às conexões, trabalhos e arquivos desse mesmo cliente.

curl "<URL_BASE>/connections" \
  -H "X-API-Key: <SUA_CHAVE>" \
  -H "Accept: application/json"

Falhas de autenticação

Uma chave ausente ou não aceita retorna HTTP 401. Não repita automaticamente: confira o ambiente, o valor completo e se a chave foi substituída.

{
  "error": {
    "code": "invalid_api_key",
    "message": "API key was not accepted.",
    "retryable": false,
    "details": {}
  }
}

Uma conta de cliente inativa retorna client_account_inactive com HTTP 403. Se o serviço de autenticação estiver temporariamente indisponível, a API retorna authentication_service_unavailable com HTTP 503.

Cuidados de integração

• Mantenha a chave somente no servidor ou em um gerenciador de segredos.
• Use variáveis de ambiente separadas para cada ambiente.
• Ao substituir uma chave, atualize o consumidor antes de remover a anterior.
• Inclua o valor retornado em X-Request-Id ao abrir um chamado.