Autenticação da API
Todas as requisições à API do PlacaFlow precisam de uma chave de API válida.
Criando uma chave
- No painel, vá em Chaves de API
- Clique em Nova chave
- Defina um nome e selecione as permissões
- Copie a chave exibida — ela não será mostrada novamente
Atenção
Guarde sua chave em um local seguro. Se perdê-la, você precisará criar uma nova.
Usando a chave
Envie a chave no header Authorization de cada requisição:
GET /api/recognitions
Authorization: Bearer pk_a1b2c3d4e5f6...
Permissões (scopes)
Cada chave tem permissões granulares:
| Scope | Descrição |
|---|---|
recognitions:read | Listar e buscar reconhecimentos |
recognitions:write | Criar reconhecimentos via API |
cameras:read | Listar câmeras |
cameras:write | Criar, editar e excluir câmeras |
alerts:read | Listar alertas |
alerts:write | Gerenciar alertas |
webhooks:read | Listar webhooks |
webhooks:write | Gerenciar webhooks |
Dica
Siga o princípio do menor privilégio: dê a cada chave apenas as permissões necessárias para sua integração.
Expiração
Chaves podem ter uma data de expiração opcional. Após essa data, requisições com a chave retornarão HTTP 401.
Erros de autenticação
| Código | Significado |
|---|---|
| 401 | Chave ausente, inválida ou expirada |
| 403 | Chave válida, mas sem permissão para este recurso |