API do CRM
A API é uma porta de entrada para outras ferramentas conversarem com o seu CRM sem você abrir a tela. Uma automação (como o n8n), um programa feito por um desenvolvedor ou uma IA (como o ChatGPT) usam essa porta para ler e gravar informações na sua conta.
Para entrar por essa porta, a ferramenta precisa de uma chave de API: uma senha longa, criada por você no CRM. Veja como criá-la em Chaves de API.
A API é dos planos Pro, Max e Agência. Nos planos Free e Plus, o CRM avisa que o plano não inclui a API ao criar uma chave (veja Planos e limites).
O que a API faz
Seção intitulada “O que a API faz”Com uma chave, uma ferramenta pode:
- Leads: criar ou atualizar um lead, buscar leads, mudar a etapa do lead numa lista, trocar o responsável, colocar e tirar tags e listas.
- Vendas: registrar e consultar vendas, com tags de venda (
tagsao registrar,addTagseremoveTagsao atualizar, filtro?tag=e a lista de tags emGET /sale-tags). O comprador vira lead (ou atualiza o lead que já existe). - Formulários: criar, consultar e alterar formulários.
- Rascunhos de e-mail: criar e ajustar campanhas de e-mail como rascunho.
- Mídia de anúncios: enviar as métricas e a estrutura de campanhas, conjuntos e anúncios, e lê-las de volta (
GET /ad-metricseGET /ad-entities). A leitura é dos planos Pro, Max e Agência. - Gatilhos (webhooks): pedir ao CRM que avise um endereço quando algo acontece, como um lead novo ou uma venda aprovada.
Quando usar a API e quando usar o webhook de entrada
Seção intitulada “Quando usar a API e quando usar o webhook de entrada”| Você quer… | Use |
|---|---|
| Que uma plataforma que já manda avisos por conta própria (como a Hotmart) registre vendas no CRM | Webhook de entrada |
| Que quem programa, um fluxo do n8n ou uma IA leia, crie e altere dados do CRM | API |
| Que o CRM avise outra ferramenta quando algo acontece | Webhook de saída ou o gatilho da API |
Em resumo: se a plataforma já sabe mandar o aviso sozinha, o webhook de entrada resolve. Se alguém precisa montar o que será enviado ou consultar o CRM, use a API.
O que a API não faz
Seção intitulada “O que a API não faz”- Não exclui leads. Ninguém apaga um lead pela API. A única coisa que ela exclui é um gatilho (webhook).
- Nunca envia e-mail. Os rascunhos criados pela API ficam esperando. Uma pessoa precisa abrir o rascunho no CRM, revisar, testar e agendar o envio.
Limite de uso
Seção intitulada “Limite de uso”Cada chave pode fazer até 120 chamadas por minuto. Passou disso, a API responde com um erro e informa quanto tempo é preciso esperar. Se um fluxo manda muitas chamadas de uma vez, divida em lotes menores ou espere um pouco entre elas.
Endereço da API
Seção intitulada “Endereço da API”Quem programa precisa do endereço base:
https://dattacrm.com.br/api/v1A lista completa de operações, com todos os campos, está na Referência técnica da API. Ela é feita para quem programa e tem alguns rótulos em inglês; você não precisa ler para criar uma chave.