Visão Geral da API
A API da BR-Dev segue os princípios REST e oferece endpoints para todas as funcionalidades da plataforma.
Base URL: https://api.br-dev.com.br/v1
Endpoints Principais
| Endpoint | Método | Descrição | Auth |
|---|---|---|---|
/api/auth | POST | Autenticação de usuários | Público |
/api/users | GET | Lista de usuários | Requer Auth |
/api/projects | GET | Lista de projetos | Requer Auth |
/api/clients | GET | Lista de clientes | Requer Auth |
Autenticação
A API utiliza autenticação via Bearer Token JWT. O token deve ser incluído no header Authorization de todas as requisições autenticadas.
Exemplo de Requisição Autenticada
curl -X GET \
'https://api.br-dev.com.br/v1/projects' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIs...'Formato das Respostas
Todas as respostas seguem um formato padrão com campos consistentes.
Sucesso
{
"success": true,
"data": {
// Dados da resposta
},
"meta": {
"page": 1,
"perPage": 10,
"total": 100
}
}Erro
{
"success": false,
"error": {
"code": "INVALID_CREDENTIALS",
"message": "Email ou senha inválidos",
"details": {}
}
}Rate Limiting
A API possui limites de requisições para garantir a estabilidade do serviço:
- Plano Básico: 1000 requisições/hora
- Plano Pro: 5000 requisições/hora
- Plano Enterprise: Personalizado
Mantenha suas chaves de API seguras e nunca as exponha no código frontend.