Documentacao da API IAra
🛠️

Erros e boas praticas

2 artigos Suporte Por Suporte

Erros HTTP, paginacao, idempotencia, uso seguro de tokens e checklist de suporte para integracoes.

Erros HTTP e diagnostico de integracoes

Erros HTTP e diagnostico de integracoes Use este guia para investigar falhas comuns sem depender de acesso interno da Digi2B. Codigos comuns | Codigo | Significado | Verifique | | --- | --- | --- | | 200/201 | Sucesso | Processar resposta e guardar IDs | | 400 | Requisicao invalida | JSON, query params e tipos | | 401 | Nao autenticado | Header api_access_token e token correto | | 403 | Sem permissao | Papel do usuario e recurso habilitado | | 404 | Nao encontrado | Conta, ID, ambiente e rota | | 422 | Validacao falhou | Campos obrigatorios, enums e regras do canal | | 429 | Muitas requisicoes | Reduzir volume e aplicar retry com espera | | 500 | Erro interno | Registrar evidencias e acionar suporte | Evidencias para suporte Envie: - metodo e endpoint; - horario com fuso; - status HTTP; - x-request-id, se houver; - payload sem dados sensiveis; - resposta de erro; - objetivo da integracao. Dica Quando houver divergencia de formato, compare com uma acao equivalente feita pelo painel da IAra usando a aba Network do navegador.

Boas praticas de integracao

Boas praticas de integracao Integre com a IAra de forma previsivel, segura e facil de diagnosticar. Token - Use token de usuario com permissao adequada. - Nao exponha token em frontend publico. - Troque o token se houver suspeita de vazamento. - Use variaveis de ambiente no backend. Idempotencia Guarde IDs externos e IDs retornados pela IAra. Antes de criar contato, conversa ou mensagem, confira se o mesmo evento ja foi processado. Retries Use retry com espera progressiva para falhas temporarias. Nao repita automaticamente erros 400, 401, 403 ou 422 sem corrigir a causa. Logs Registre metodo, rota, status, horario, recurso afetado e x-request-id. Nao registre token nem conteudo sensivel de mensagens. Homologacao Teste com poucos contatos e conversas antes de rodar importacoes ou automacoes em volume. Limites de escopo Se a integracao depender de uma configuracao que nao aparece na sua conta, abra demanda com a Digi2B.