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 erroretorno.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 deretorno.registros[].registro.erros[]:
Status de Processamento
O campostatus_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
- Sempre verifique o campo
statusantes de processar o retorno - Leia as mensagens em
erros[]para entender o problema específico - Use o
codigo_erropara tratamento programático - Implemente retry logic para erros temporários (ex: timeout)
- Valide os dados localmente antes de enviar para reduzir erros de validação
Exemplo de Tratamento em PHP
Consulte Também
- Limites da API - Entenda os rate limits e quotas
- Fluxo Sugerido - Melhores práticas de integração
- Introdução - Informações básicas da API v2
