Guia completo para integrar e usar nossa API de dados cadastrais
Comece a usar nossa API em menos de 5 minutos
Cadastre-se gratuitamente e receba 5 consultas de teste por dia.
Crie sua chave de API única e segura no painel de controle.
Use sua API key para fazer sua primeira consulta de dados.
Implemente a API em sua aplicação e comece a usar.
Como autenticar suas requisições à API
Todas as requisições à APIdev devem incluir sua API key no header X-API-Key.
GET /api/v1/data/12345678901 HTTP/1.1
Host: api.apidev.com.br
X-API-Key: sua_api_key_aqui
Content-Type: application/jsoncurl -X GET "https://api.apidev.com.br/api/v1/data/12345678901" \
-H "X-API-Key: sua_api_key_aqui" \
-H "Content-Type: application/json"const apiKey = 'sua_api_key_aqui';
fetch('https://api.apidev.com.br/api/v1/data/12345678901', {
method: 'GET',
headers: {
'X-API-Key': apiKey,
'Content-Type': 'application/json'
}
})
.then(response => response.json())
.then(data => console.log(data));Importante: Mantenha sua API key em segredo e nunca a exponha em código cliente-side.
Todos os endpoints disponíveis na APIdev
Consulta informações cadastrais usando um CPF
GET /api/v1/data/{cpf}| Parâmetro | Tipo | Descrição |
|---|---|---|
cpf |
string | CPF com 11 dígitos numéricos |
{
"success": true,
"data": {
"cpf": "12345678901",
"name": "João Silva",
"status": "active",
"last_updated": "2024-01-15T10:30:00Z"
},
"usage": {
"requests_today": 3,
"limit_today": 1000
}
}{
"success": false,
"error": "CPF not found",
"message": "O CPF informado não foi encontrado em nossa base de dados"
}Verifica se a API está funcionando corretamente
GET /api/v1/status{
"success": true,
"status": "healthy",
"version": "1.0.0",
"timestamp": "2024-01-15T10:30:00Z"
}Obtém estatísticas de uso da sua conta
GET /api/v1/usage{
"success": true,
"data": {
"plan": "Pro",
"requests_today": 45,
"limit_today": 10000,
"requests_month": 1250,
"remaining_today": 9955
}
}Limites de requisições por plano
| Plano | Requisições/Dia | Requisições/Hora | Conexões Simultâneas |
|---|---|---|---|
| Free | 5 | 1 | 1 |
| Basic | 1.000 | 50 | 5 |
| Pro | 10.000 | 500 | 20 |
| Enterprise | Ilimitado | Custom | Custom |
Headers de Rate Limiting: Cada resposta inclui headers X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset.
Entenda os possíveis erros e como tratá-los
Requisição malformada ou parâmetros inválidos.
API key ausente, inválida ou expirada.
Sem permissão para acessar o recurso.
Recurso não encontrado (CPF inválido ou inexistente).
Limite de requisições excedido.
Erro interno do servidor.
Servidor de gateway inválido.
Serviço temporariamente indisponível.
Timeout do gateway.
Integração facilitada com nossas bibliotecas oficiais