Introdução

​

Autenticação

​

Recomendado: token Bearer

Authorization: Bearer cbr_live_your_api_key_here

​

Alternativa: cabeçalho X-Api-Key

X-Api-Key: cbr_live_your_api_key_here

​

Criando chaves de API

1. Faça login na sua instância do CaseBender
2. Acesse Conta → Chaves de API
3. Clique em Criar chave de API
4. Configure o nome, a descrição, o nível (tier) e os escopos (scopes) da chave
5. Salve a chave imediatamente — ela é exibida apenas uma vez e não pode ser recuperada depois

cbr_live_a1b2c3d4e5f6g7h8i9j0...

​

Usando chaves de API

​

Com cURL

curl -X GET https://your-instance.casebender.com/api/v1/alerts \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​

Com Python (biblioteca requests)

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY_HERE",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://your-instance.casebender.com/api/v1/alerts",
    headers=headers
)

​

Com JavaScript/Node.js (fetch)

const response = await fetch(
  "https://your-instance.casebender.com/api/v1/alerts",
  {
    method: "GET",
    headers: {
      "Authorization": "Bearer YOUR_API_KEY_HERE",
      "Content-Type": "application/json",
    },
  }
);

​

Níveis de chaves de API

​

Escopos de chaves de API

• alerts:read - Ler alertas
• alerts:write - Criar e atualizar alertas
• cases:read - Ler casos
• cases:write - Criar e atualizar casos
• observables:read - Ler observáveis
• observables:write - Criar e atualizar observáveis
• users:read - Ler informações de usuários
• admin:* - Operações administrativas

​

Erros de autenticação comuns

• 401 Unauthorized:
  • Cabeçalho Authorization ausente
  • Chave de API inválida ou expirada
  • A chave de API foi revogada ou suspensa
• 403 Forbidden:
  • A chave de API não tem o escopo necessário para a operação
  • Restrições de acesso TLP/PAP
• 429 Too Many Requests:
  • Limite de taxa excedido para o seu nível

​

Boas práticas de segurança

• Nunca compartilhe sua chave de API — trate-a como uma senha
• Rotacione as chaves de API regularmente — revogue chaves antigas e crie novas periodicamente
• Use chaves diferentes para aplicações diferentes — isso permite revogar o acesso por aplicação
• Defina datas de expiração — configure as chaves de API para expirarem automaticamente quando possível
• Use os escopos mínimos necessários — conceda apenas as permissões de que sua aplicação precisa

​

Autenticação legada (obsoleta)

# Obsoleto — não use para novas integrações
curl -X GET https://your-instance.casebender.com/api/v1/alerts \
  -H "x-api-key: YOUR_ACCESS_KEY" \
  -H "x-api-secret: YOUR_SECRET_KEY"