Boas práticas e suporte
10. Boas práticas de integração
- Cadastre o responsável (6.9) uma vez por CNPJ, não por lead. Guarde o
idretornado e
reuse em todos os leads dessa imobiliária — chamar de novo com a mesma pessoa é seguro
(idempotente), mas não recadastra. - Cache do token. Reutilize o access token até perto do vencimento; não solicite um novo
por requisição. - Backoff exponencial em 5xx. Todos os
*_INTEGRATION_FAILUREsão transitórios e a
operação pode ser repetida. Comece em ~1s e dobre, com jitter, até um teto de tentativas. - Repetir o fechamento do contrato (6.11) com o mesmo
contractResponsibleIdé seguro.
Vira um no-op. Repetir com umcontractResponsibleIdoucontractTermsdiferente hoje
não dá erro (ver gap conhecido em 6.11) — confira a resposta antes de assumir que o
valor novo foi gravado. - Não repita 4xx com o mesmo payload.
400,403,409e422são determinísticos.
Corrija o payload ou o estado antes. - Ramifique por
code, nunca pormessage. As mensagens mudam sem aviso; os códigos não. - Prefira webhooks a polling. Use os endpoints de status como fallback ou reconciliação,
não como mecanismo principal. Para assinatura não existe alternativa: só há webhook. - Deduplique eventos por
id. Entrega é at-least-once. - Teste com
POST /webhooks/{id}/pingantes de depender do webhook em produção, e
verifiquesuccessno corpo — não o status HTTP. - Monitore
consecutiveFailuresestatusdos seus webhooks. Cinco falhas consecutivas
suspendem a entrega; você para de receber eventos sem nenhum erro aparecer no seu lado. - Persista o
idApplication. É a chave de todo o fluxo pós-lead e de correlação com o
suporte Creditas. - Nunca logue segredos.
auth.value,clientSecrete o access token não devem aparecer
em log do seu lado — a Creditas já os mascara do dela. - Use
GET /leads(6.3) para reconciliação, não como fonte primária de estado. É
paginação por offset — não use como substituto de webhooks para saber quando algo mudou;
use para conferir periodicamente o que foi produzido, ou para reconstruir estado após uma
lacuna de eventos.
11. Suporte
- Ao abrir chamado, informe:
idApplication(oupreProfileAnalysisId), horário UTC da
chamada, endpoint,coderecebido e omessagecompleto. - Para problemas de entrega de webhook, informe também o
X-Creditas-Delivery-Idou oid
da entrega emGET /webhooks/{id}/deliveries.
Updated about 1 hour ago
