Guias
Receitas de ponta a ponta e operação do dia a dia, para além da referência de cada endpoint.
A Referência descreve cada endpoint isoladamente. Esta seção mostra os endpoints trabalhando juntos, na ordem em que uma integração real os chama, e o que fazer depois que ela está no ar.
Guias disponíveis
Guia rápido: integração completa
quem está construindo a integração
uma sessão de terminal do CRM vazio até a negociação ganha, com todos os recursos encadeados e as chamadas de uso diário
Gerenciamento de chaves no painel
quem administra a conta
criar, editar escopos, auditar e revogar chaves, além do log de requisições para diagnóstico
Padrões que valem para qualquer integração
Idempotência. A API não tem chave de idempotência. Para não duplicar registros ao reprocessar, consulte antes de criar: contatos por phone ou por custom__<campo> com o id do seu sistema, empresas por cnpj, produtos e origens por name.
Retentativas. Repita apenas 429 e 500, com espera crescente e respeitando o RateLimit-Reset. Um 422 nunca melhora na segunda tentativa: registre o corpo e trate o dado na origem.
Sincronização em lote. Prefira listagens com per_page=100 e filtros de data (updated_at__gte) para trazer só o que mudou desde a última execução, em vez de varrer a coleção inteira.
Rastreabilidade. Grave o id do seu sistema em um campo personalizado do contato. Ele é o único recurso com filtro custom__, o que o torna o ponto de amarração natural entre o seu banco e o CRM.
Diagnóstico. Antes de abrir chamado, consulte API ▸ Requisições no painel: método, rota, status e duração de cada chamada feita com as chaves da conta ficam registrados lá.
Nesta seção
Atualizado