API REST e webhooks para ligar o Nestor ao resto da sua operação

Mande leads de sites e portais, leia o cadastro e receba eventos assinados quando algo muda. Cada imobiliária cria as próprias chaves.

A documentação fica em docs.nestorcrm.com.br e é gerada a partir da especificação OpenAPI 3.1.

Recursos e comportamento previsíveis

  • Recursos: leads, contatos, atividades, empreendimentos, unidades, imóveis, corretores e etapas.
  • Chaves por imobiliária, criadas no painel, com escopos de leitura e escrita por recurso, e chave de teste separada da de produção.
  • Paginação por cursor e filtro por data de atualização.
  • Idempotência nos POST, com o cabeçalho Idempotency-Key.
  • Limite de requisições por chave, com resposta 429 e Retry-After.
  • Erros sempre no mesmo formato.

Criar um lead Exemplo ilustrativo

curl -X POST https://api.nestorcrm.com.br/v1/leads \
  -H "Authorization: Bearer $NESTOR_API_KEY" \
  -H "Idempotency-Key: 7c1f0d1e-example" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Exemplo",
    "phone": "+5500000000000",
    "source": "site",
    "development_id": "dev_example"
  }'

Eventos assinados, com reenvio

Cada envio é assinado com HMAC, tem nova tentativa com espera crescente, e o painel guarda o registro das entregas, com botão para reenviar.

  • lead.createdlead entrou
  • lead.assignedatribuído a um corretor
  • lead.stage_changedmudou de etapa
  • lead.wonvenda fechada
  • lead.lostlead perdido
  • visit.scheduledvisita marcada
  • unit.reservedunidade reservada

O que as integrações costumam fazer

  • Enviar ao Nestor os leads do site próprio e dos portais, com origem e campanha.
  • Avisar o sistema financeiro quando uma unidade é reservada.
  • Alimentar um painel de BI com leads, etapas e vendas.
  • Disparar uma automação própria quando um lead muda de etapa.
Falar no WhatsApp