API de Parceiros (v1)

Porta de entrada para sistemas de terceiros no CRM da Chaves na Mão. Com ela o seu sistema consulta os leads disponíveis para contato, consulta a tabela de planos vigente e devolve para o CRM o que aconteceu em cada ligação.

Antes de escrever código, leia "Como o CRM funciona"

Os campos desta API são simples. As regras do CRM por trás deles não são, e quase todo erro de integração vem de supor como ele funciona em vez de conferir. São quatro páginas curtas e elas economizam retrabalho.

Mapa da documentação

• Considerações iniciais
  • Ambiente de testes
  • Ambiente de produção
  • Autenticação
  • Limite de requisições
  • Status de respostas das requisições
  • Formato de datas
• Como o CRM funciona
  • O caminho do lead
  • Tarefas e anotações
  • O que parece defeito e não é
• Leads
  • Endpoint
  • Objeto do lead
• Planos
  • Endpoint
  • Objeto da faixa
• Resultado da ligação
  • Endpoint
  • Objeto de envio
  • Idempotência
• Fluxo recomendado

Os três endpoints

Método	Endpoint	Ação	Escopo
GET	/partners/ping	Confere a chave, os escopos e a conectividade.	nenhum
GET	/partners/leads	Lista os leads disponíveis para contato.	leads:read
GET	/partners/planos	Consulta a tabela de planos vigente, em faixas de quantidade.	plans:read
POST	/partners/resultados-chamada	Grava no card do lead o que aconteceu na ligação.	call-results:write

Só o último escreve no CRM. Os outros três apenas leem.

Primeira chamada

Antes de qualquer coisa, confirme que a sua chave chega até nós:

curl --location --request GET 'https://crm.chavesnamao.com.br/api/v1/partners/ping' \
--header 'x-api-key: sua-chave-aqui'

{
  "success": true,
  "parceiro": "3C Plus",
  "chave": "cnmp_3cplus_...a1b2",
  "escopos": ["leads:read", "plans:read", "call-results:write"],
  "data_hora": "2026-10-22T14:30:00-03:00"
}

Se isso responder, o resto é contrato. Se não responder, a resposta diz o que fazer: veja Status de respostas das requisições.

Suporte

Dúvida sobre a integração, erro 500 ou comportamento que a documentação não explica: tecnologia@chavesnamao.com.br, informando endpoint, corpo enviado, data e hora da chamada.