API Reference
API REST JSON sobre HTTPS. Baseada em FastAPI com OpenAPI 3.1. Disponível para planos Professional e Enterprise.
Autenticação
Todas as requests requerem header Authorization: Bearer <token>.
Tokens de API (recomendado para integrações)
Gere em Configurações → API → Novo Token. Tokens não expiram mas podem ser revogados.
JWT de usuário (para apps interativos)
Obtenha via POST /auth/token com e-mail e senha. Expira em 1 hora. Use refresh token para renovar.
# Listar anomalias críticas
curl -X GET "https://api.audit.me/v1/anomalies?severity=critical" \
-H "Authorization: Bearer seu_token_aqui" \
-H "Content-Type: application/json"
Base URL
https://api.audit.me
Ambiente de staging (sandbox): https://staging-api.audit.me
Endpoints Principais
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /v1/anomalies | Lista anomalias do tenant com paginação e filtros |
| GET | /v1/anomalies/{id} | Detalhes de uma anomalia específica com evidências |
| POST | /v1/master-brain/query | Faz uma pergunta ao Master Brain |
| GET | /v1/transactions | Lista transações normalizadas de todas as fontes |
| GET | /v1/connectors | Status de todos os conectores do tenant |
| POST | /v1/connectors/{id}/sync | Força re-sincronização de um conector |
| GET | /v1/knowledge-graph/entities | Lista entidades do Knowledge Graph |
| GET | /v1/workflow/engagement | Status do workflow de engajamento ativo |
| GET | /v1/reports/dre | DRE do tenant em formato JSON |
| POST | /v1/webhooks | Cadastra webhook para eventos de anomalia |
Documentação completa com schemas e exemplos: API Reference interativa →
Rate Limits
| Plano | Requests/min | Requests/dia |
|---|---|---|
| Starter | 60 | 10.000 |
| Professional | 300 | 100.000 |
| Enterprise | Sem limite | Sob contrato |
Rate limit excedido retorna HTTP 429 com header Retry-After.