Documentação

Visão Geral

API Brasil oferece acesso programático aos serviços disponíveis na plataforma. Para usar a API, você precisará de um token de autenticação e seguir as regras de uso estabelecidas.

Endpoints

POST https://services.apiconsultabrasil.com/
                            

Formato da Requisição

{
    "token": "seu_token_aqui",
    "target": "cpf-basico-pessoa-fisica",
    "pacote": "basico",
    "query": "00000000000"
}
                            

Campos obrigatórios:

• token: Token de autenticação obtido na página de tokens
• target: Identificador do serviço desejado
• pacote: Tipo de pacote contratado
• query: Dados de consulta específicos do serviço

Respostas HTTP

{
    "success": true,
    "data": {
        // Dados retornados pelo serviço
    }
}
                            

{
    "success": false,
    "message": "Campos ausentes: token, target, pacote, query"
}
                            

{
    "success": false,
    "message": "Token inválido ou expirado"
}
                            

{
    "success": false,
    "message": "Tamanho da requisição muito grande"
}
                            

{
    "success": false,
    "message": "Aguarde mais X segundos antes de fazer outra requisição",
    "seconds_remaining": X
}
                            

{
    "success": false,
    "message": "Erro interno do servidor"
}
                            

Limites e Restrições

• Tamanho máximo da requisição: 1MB
• Rate limiting: 1 requisição a cada 10 segundos por IP
• Formato de dados: JSON válido
• Todos os campos são obrigatórios

Segurança

• Todas as requisições devem ser feitas via POST
• Requisições são logadas para auditoria
• Rate limiting para prevenir abuso
• Validação de token em cada requisição

Exemplo de Uso

// Exemplo em JavaScript
const data = {
    token: "seu_token_aqui",
    target: "cpf-basico-pessoa-fisica",
    pacote: "basico",
    query: "00000000000"
};

fetch('https://services.apiconsultabrasil.com/', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Erro:', error));