API Keys

Gerencie chaves de acesso para integracoes externas com a API do Defender360.

Visao Geral

API Keys permitem que sistemas externos acessem a API do Defender360 de forma segura e controlada.

Quando Usar

Criar API Key

Passo a Passo

1. Acesse Configuracoes > Integracoes > API Keys
2. Clique em Nova API Key
3. Preencha os campos:

4. Clique em Criar
5. Copie a chave imediatamente - ela nao sera exibida novamente

Escopos Disponiveis

Tickets

Usuarios

Clientes

CMDB

Outros

Autenticacao

Header de Autorizacao

Use a API Key no header Authorization:

curl -X GET "https://api.defender360.com/v1/tickets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Query Parameter (Nao Recomendado)

Alternativamente, pode ser passada como query parameter:

curl -X GET "https://api.defender360.com/v1/tickets?api_key=YOUR_API_KEY"

Rate Limiting

Limites Padrao

Headers de Rate Limit

A API retorna headers informativos:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1620000000

Exceder o Limite

Ao exceder o limite, a API retorna:

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "retry_after": 30
}

Status HTTP: 429 Too Many Requests

Configurar Limite Customizado

Para chaves que necessitam maior volume:

1. Edite a API Key
2. Na secao Rate Limit, ajuste o valor
3. Limite maximo configuravel: 10.000 req/min
4. Clique em Salvar

Restricao de IP

Configurar Whitelist

Limite o uso da chave a IPs especificos:

1. Edite a API Key
2. Na secao IPs Permitidos, adicione os IPs:

# IP unico
192.168.1.100

# Range CIDR
10.0.0.0/8

# Multiplos IPs
200.100.50.10
200.100.50.11

3. Clique em Salvar

Rotacao de Chaves

Por Que Rotacionar

• Funcionario que conhecia a chave saiu da empresa
• Chave foi exposta acidentalmente
• Politica de seguranca exige rotacao periodica
• Integracao foi comprometida

Como Rotacionar

1. Crie uma nova API Key com os mesmos escopos
2. Atualize a integracao com a nova chave
3. Teste se a nova chave funciona
4. Revogue a chave antiga

Rotacao Automatica

Configure rotacao periodica:

1. Edite a API Key
2. Na secao Expiracao, defina a validade
3. Ative Notificar antes de expirar
4. Configure o periodo de aviso (ex: 7 dias)

Revogar API Key

Quando Revogar

• Chave comprometida
• Integracao desativada
• Funcionario desligado
• Teste finalizado

Como Revogar

1. Acesse a lista de API Keys
2. Localize a chave
3. Clique em Revogar
4. Confirme a acao

Auditoria

Logs de Uso

Monitore o uso de cada API Key:

1. Clique na API Key
2. Acesse a aba Logs
3. Visualize:
   • Requisicoes realizadas
   • Endpoints acessados
   • IPs de origem
   • Status das respostas

Exportar Logs

Para auditoria externa:

1. Selecione o periodo
2. Clique em Exportar
3. Escolha o formato (CSV, JSON)
4. Baixe o arquivo

Erros Comuns

Boas Praticas

Proximos Passos