Erros

Neste guia, vamos falar sobre o que acontece quando algo dá errado enquanto você trabalha com a API. Erros acontecem, e na maioria das vezes eles serão seus, não nossos. Vamos analisar alguns códigos de status e tipos de erro que você pode encontrar.

Você pode verificar se sua solicitação foi bem-sucedida conferindo o código de status ao receber uma resposta da API. Se a resposta indicar falha, você pode usar o tipo de erro e a mensagem de erro para entender o que deu errado e fazer uma depuração básica (antes de entrar em contato com 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 na sua integração.
Name
5xx
Description
Um código de status 5xx indica um erro do servidor — você não deverá vê-los.

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"
  }