Formato padrão
code é o melhor ponto de partida para tratar erros de forma programática. Já o campo error_messages traz detalhes que ajudam a entender qual campo ou regra precisa de atenção.
Códigos HTTP
Erros de negócio comuns
Como investigar
1
Confira a autenticação
Se o status for
401, confirme se o header apiKey ou token foi enviado e se pertence ao mesmo ambiente da URL usada.2
Confira o acesso à empresa
Se o status for
403, revise o companyId e as permissões da credencial. A API valida o acesso por empresa e por recurso.3
Revise o payload
Se o status for
400, leia error_messages. Falhas de validação usam Zod e podem indicar o campo, o path e a localização do problema.4
Valide os IDs enviados
Se o status for
404, confirme se o recurso existe, se pertence à empresa acessada e se o ID correto está sendo usado.