Integração
Cadastro geral de leads e leitura paginada da timeline para BI, mídia e automações.
listas 300/min · detalhe 60/minCadastre e consulte leads, encontre horários e crie agendamentos com uma API previsível, autenticada por chave e isolada por clínica.
Visão geral
A mesma chave pode combinar escopos de integração e agenda. Cada grupo tem seu próprio contador, evitando que a sincronização de leads bloqueie um agendamento.
Cadastro geral de leads e leitura paginada da timeline para BI, mídia e automações.
listas 300/min · detalhe 60/minProfissionais, serviços, disponibilidade e criação de agendamentos.
scheduling:* · 60 req/minInício rápido
curl --request GET \
--url 'https://api.northcliniccrm.com.br/api/v1/integration/leads?limit=20' \
--header 'X-API-Key: ncrm_live_sua_chave'Do cadastro ao agendamento
Com o escopo leads:write, envie nome etelefone com DDI e DDD para POST /integration/leads. A resposta retorna data.id: status 201 para um novo cadastro ou 200 para um lead ativo já existente pelo telefone na clínica.
Para agendar, use também o escopo scheduling:write e envie esse ID no campo lead_id dePOST /scheduling/appointments, junto ao serviço, profissional, sala, data e horários consultados. O fluxo em uma chamada continua disponível: envie o objeto lead com nome e telefone no agendamento. Use exatamente uma alternativa: lead_id ou lead.
curl --request POST \
--url 'https://api.northcliniccrm.com.br/api/v1/integration/leads' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: ncrm_live_sua_chave' \
--data '{
"nome": "Maria Santos",
"telefone": "5511999998888",
"origem": "Google Ads",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "avaliacao_outubro",
"utm_content": "video_1",
"utm_term": "emagrecimento",
"referencia_externa": "integrador:registro-123"
}'Mapeamentos prontos
Cada integrador transforma seus campos para o contrato acima. Guarde a API Key no cofre de credenciais da plataforma, normalize o telefone com DDI e DDD e preserve umareferencia_externa estável nos retries.
name → nome, phone → telefone, UTMs homônimas e n8n:{{$json.id}} como referência.
POST · JSON · X-API-KeyBody Raw/JSON, campos mapeados do bundle e make:ID_DO_EVENTO como referência estável.
POST · application/jsonDesative Data Pass-Through, envie apenas o contrato do North e use o ID do registro de origem na referência.
Retry 429/503 com backoffname, personal_phone/mobile_phone e traffic_* viram nome, telefone e UTMs.
referencia_externa: rdstation:ID429 ou 503, aguarde Retry-After e repita o mesmo evento. Respostas 201/created: true e 200/created: false indicam captação aceita; o segundo caso mantém a etapa atual e acrescenta um novo touchpoint.Autenticação
Envie a chave no header X-API-Key. Prefira chaves separadas para cada integrador, conceda apenas os escopos necessários e revogue a chave ao encerrar o acesso.
Limites e desempenho
Os limites protegem todas as clínicas contra rajadas e consultas repetidas. Eles são suficientes para sincronização incremental; excedê-los continuamente indica que o fluxo deve usar paginação, backoff ou webhooks.
Em uma resposta 429, aguarde o número de segundos de Retry-After. Os headers X-RateLimit-* mostram o saldo e o reinício da janela.
Boas práticas
Receba eventos e consulte detalhes somente quando houver mudança.
Pagine listas e persista o último cursor processado.
Em 429 ou 5xx, aguarde e aumente progressivamente o intervalo.
Use X-Webhook-Delivery como chave idempotente.
OpenAPI
Usamos cookies para medir o site e os anúncios. Você escolhe. Política de privacidade