Skip to main content

Visão Geral

Quando uma requisição à API v2 falha, o retorno inclui campos específicos para identificar o problema:
  • retorno.status: “Erro”
  • retorno.codigo_erro: Código numérico do erro
  • retorno.erros[]: Lista de mensagens descritivas dos erros

Códigos de Erro Comuns

Estrutura de Retorno de Erro

Erros de Validação

Para operações de inclusão e alteração, erros específicos são retornados dentro de retorno.registros[].registro.erros[]:

Status de Processamento

O campo status_processamento indica o resultado da operação:
A documentação completa de todos os códigos de erro não está disponível publicamente. As mensagens em retorno.erros[] fornecem detalhes específicos sobre cada erro encontrado.

Tratamento de Erros

Boas Práticas

  1. Sempre verifique o campo status antes de processar o retorno
  2. Leia as mensagens em erros[] para entender o problema específico
  3. Use o codigo_erro para tratamento programático
  4. Implemente retry logic para erros temporários (ex: timeout)
  5. Valide os dados localmente antes de enviar para reduzir erros de validação

Exemplo de Tratamento em PHP

Consulte Também