API Reference

Tratamento de Erros

Referência de Códigos de Erro da API: Solucionando Problemas Rapidamente

Ao utilizar nossa API, é possível que você encontre mensagens de erro originadas por vários motivos, como a ausência do Token de Autenticação, Token Inválido, CNPJ não encontrado, entre outros. Visando simplificar a compreensão desses erros para sua aplicação, identificamos os problemas mais frequentes e mapeamos os códigos correspondentes. Dessa forma, você poderá usar o código de erro para tomar as medidas necessárias em sua aplicação.

A tabela a seguir apresenta os principais códigos retornados em nossas respostas:

CódigoDescrição
1000O valor pesquisado não existe ou não foi localizado
1001Não foi informado um Token de Autenticação na solicitação
1002O Token de Autenticação informado na solicitação é inválido
1003Você excedeu a quantidade de chamadas por minuto permitidas para o seu plano
1004Você não tem créditos disponíveis para realizar a consulta
1005Seu plano não permite consultas em tempo real
1006Você não tem créditos disponíveis para realizar consultas com dados em tempo real
9999Código retornado para erros genéricos ou que ainda não forma mapeados, observar a descrição do erro para mais detalhes

Exemplo de resposta contendo código de erro:

{
    "status": "Error",
    "code": 1002,
    "message": "Auth Token not provided or invalid."
}

É fundamental que você consulte regularmente esta seção para se familiarizar com os códigos de erro e suas respectivas ações recomendadas. Entender esses códigos facilita a resolução eficiente de problemas e melhora a integração de sua aplicação com nossa API.

Caso surjam dúvidas ou necessite de assistência adicional, não hesite em entrar em contato com nossa equipe de suporte, que está pronta para garantir uma experiência tranquila e eficaz durante o uso da nossa API.


Restaram dúvidas, entre em contato com a nossa equipe através do e-mail [email protected]