Autenticação

API keys, Bearer tokens e scopes

Todas as requests à API exigem um header Authorization com um Bearer token (API key). Cada conta pode gerar múltiplas keys nomeadas, ver o último uso e revogá-las a qualquer momento.

Formato do header

http
Authorization: Bearer cbct_live_a3f9b1c2d4e5f6g7h8i9j0k1l2m3n4o5

Como criar uma API key

  1. Crie uma conta em cbcthub.com/signup (plano Free disponível).
  2. No dashboard, abra Ajustes → API.
  3. Dê um nome descritivo (ex.: “Sistema clínico interno”) e clique em Criar key.
  4. A key é mostrada UMA ÚNICA VEZ. Copie e guarde no seu secret manager (variáveis de ambiente, AWS Secrets Manager, Vault, Doppler).
Se você perder uma key, não podemos recuperá-la. Revogue e crie uma nova.

Permissões por scope

Cada key tem scopes que determinam o que ela pode fazer. Hoje as keys são criadas com ambos os scopes ativados:

  • exams:readlistar e ler exames
  • exams:writecriar, confirmar e excluir exames

Revogar keys

Em Ajustes → API você pode revogar qualquer key. A revogação é imediata: chamadas posteriores retornam 401. As keys revogadas continuam no histórico para auditoria, mas não podem ser reativadas.

O que acontece se a key for inválida

Se a key estiver ausente, malformada, inválida ou revogada, você recebe 401 unauthorized:

json
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}