Documentação Detalhada da API RiskFlow

Introdução

Bem-vindo à documentação detalhada da API RiskFlow. Este documento fornece informações completas sobre todos os endpoints disponíveis, incluindo exemplos de requisição e resposta, parâmetros necessários, cabeçalhos, autenticação e tratamento de erros.

Índice

1. Autenticação
2. Usuários
3. Fluxo de Aprovação por Alçada
4. Análises
5. Métricas
6. Métricas Avançadas
7. Alertas de SLA
8. Notificações
9. Auditoria
10. Dashboards
11. Exportação
12. Retenção de Logs

Como usar esta documentação

Cada seção contém:

• Descrição geral do módulo
• Lista de endpoints disponíveis
• Exemplos detalhados de requisição e resposta
• Parâmetros e cabeçalhos necessários
• Códigos de status e mensagens de erro
• Casos de uso comuns

Os exemplos são fornecidos em múltiplos formatos:

• cURL para testes via linha de comando
• JavaScript (Fetch API) para integração frontend
• Node.js (Axios) para integração backend

Convenções

• {variavel}: Indica um valor que deve ser substituído
• BASE_URL: URL base da API (ex: http://localhost:3000)
• Todos os exemplos assumem que você já possui um token JWT válido

Autenticação

Todos os endpoints protegidos requerem autenticação via API Key (JWT). O token pode ser enviado de duas formas:

• Header x-api-key: Método recomendado
• Header Authorization: Com prefixo "Bearer"

Para mais detalhes, consulte a seção de Autenticação.