API pública e integrações

Pra que serve a API

O CRM é o lugar onde o cliente mora. Então tudo que gera cliente deveria terminar aqui: o formulário do seu site, o seu sistema de gestão, aquela automação que você montou no n8n.

Lead que chega e não entra no CRM é lead que você vai esquecer. A API existe pra fechar esse buraco.

Com ela você cadastra leads do site direto no funil, sincroniza contatos e empresas, cria atividades, consulta relatórios e recebe avisos automáticos (webhooks) quando um negócio muda. São 38 endpoints REST sobre negócios, contatos, empresas, atividades, funis e relatórios.

A referência completa, com exemplos de código e a resposta de cada endpoint, fica na Central de Ajuda: [Referência da API](/guia/api). Dentro do CRM, a mesma documentação está em Documentação da API (/docs/api).

Como criar uma chave de API

1. Vá em Configurações → Chaves de API (/settings/api-keys). Só dono ou admin do workspace acessa.
2. Clique pra criar uma nova chave e dê um nome que identifique o uso (ex.: "n8n produção").
3. Copie o token completo (formato rmk_...).

Cada chave pertence a um único workspace: as chamadas só enxergam e só alteram dados daquele workspace. Revogar uma chave vale na hora — a próxima chamada com ela recebe erro 401.

Como autenticar as chamadas

Envie o token no header de cada requisição: Authorization: Bearer rmk_... (o header X-API-Key também é aceito).

Use a chave apenas em ambiente de servidor — backend, função serverless, n8n, Make ou Zapier. A chave nunca deve aparecer no navegador do seu site.

Limites de uso da API

• 100 requisições por minuto por chave, com tolerância de pico de até 200.
• Ao estourar, a API responde erro 429 com o header Retry-After dizendo quantos segundos esperar. Ferramentas como o n8n respeitam isso automaticamente.
• Listagens são paginadas por cursor: use limit (até 100) e repasse o nextCursor da resposta anterior até hasMore vir false.

Como receber webhooks (avisos automáticos)

Webhooks avisam o seu sistema quando algo acontece no CRM — negócio criado, ganho, perdido, contato atualizado, atividade concluída, entre outros.

1. Vá em Configurações → Webhooks (/settings/webhooks).
2. Cadastre a URL do seu sistema e escolha os eventos que quer receber.
3. Valide cada entrega com o header X-Webhook-Signature (HMAC-SHA256 do corpo, usando o secret exibido no cadastro) — é o que garante que o aviso veio mesmo do CRM.

Entregas com falha são retentadas até 6 vezes com intervalos crescentes (de 1 minuto a 24 horas). Depois de 50 falhas consecutivas, o webhook é desativado — reative depois de corrigir a sua URL.

Erros comuns da API

• 401 UNAUTHORIZED: token ausente, com formato errado ou revogado. Confira o header Authorization e se a chave ainda existe em Configurações → Chaves de API.
• 404 NOT_FOUND: o recurso não existe ou pertence a outro workspace (a chave só enxerga o workspace dela).
• 422 VALIDATION_ERROR: algum campo do body é inválido; o campo details da resposta lista o que corrigir.
• 429 RATE_LIMITED: limite de requisições estourado; espere o tempo do header Retry-After.

Uma coisa que a API não faz (e não vai fazer)

Ela não dispara mensagem em massa pros seus contatos.

Você integra o que quiser, traz lead de onde quiser, sincroniza o que precisar. Mas o envio pro cliente continua passando por uma pessoa. Isso é decisão de produto, e ela não vai mudar: quem automatiza o contato com o cliente está fazendo marketing, não vendas.