Erros

Neste guia, explicamos como identificar e tratar possíveis erros ao utilizar a API.

Durante a integração, uma solicitação pode falhar por diferentes motivos, como parâmetros inválidos, autenticação incorreta, saldo insuficiente, limites de uso ou indisponibilidade temporária de algum serviço externo.

Para verificar se uma solicitação foi concluída com sucesso, consulte o código de status retornado pela API. Caso a resposta indique falha, utilize o tipo de erro e a mensagem retornada para entender o motivo e realizar uma primeira análise antes de acionar o suporte.

Antes de entrar em contato com o suporte sobre um erro, esteja ciente de que 99% de todos os erros relatados são, na verdade, erros do usuário. Portanto, revise cuidadosamente seu código antes de contatar o suporte da Sintegrapi.

Status codes

Aqui está uma lista das diferentes categorias de códigos de status retornados pela API da SintegrAPI. Use essas informações para entender se uma solicitação foi bem-sucedida.

Name
2xx
Description
Um status 2xx indica que uma resposta com sucesso.
Name
4xx
Description
Um status 4xx indica um erro do lado do cliente — isso significa que algo deu errado em sua integração.
Name
404
Description
Um status 404 indica que o recurso é válido, porém não existe na fonte oficial ou em cache.
Name
500
Description
Um código de status 500 indica um erro do servidor.
Name
503
Description
A fonte externa consultada (Sintegra, CCC, Receita Federal, Ibama ou outra) encontra-se indisponível, não respondeu à requisição ou retornou um erro.

Créditos não são descontados em caso de erros 5xx ou 4xx.

Tipos de erro

Sempre que uma solicitação falhar, a API da Sintegrapi retornará uma resposta de erro com um tipo de erro e uma mensagem. Você pode usar essas informações para entender melhor o que deu errado e como corrigir. A maioria das mensagens de erro é bastante útil e acionável.

Aqui está uma lista dos dois tipos de erro suportados pela API da Sintegrapi — use essas informações para entender o que você fez de errado.

Name
api_error
Description
Isso significa que nós cometemos um erro, o que é altamente especulativo e improvável.
Name
invalid_request
Description
Isso significa que você cometeu um erro, o que é muito mais provável.

Error response


  {
      "message": "Ocorreu um erro do lado do servidor",
      "code": "api_error"
  }