Documentação para desenvolvedores

O que a API faz, quando usar e como conseguir acesso para o seu sistema.

O CRM do Clube do Lab registra de onde vem cada contato do laboratório: a página, a campanha, o canal de anúncio e a cidade. A API de integração completa a outra metade da história, trazendo do sistema de atendimento ou de gestão do laboratório o que aconteceu depois: o orçamento, o valor e se a venda foi fechada ou perdida.

Com as duas metades juntas, o laboratório passa a ver quanto cada canal e cada página vendeu, sem digitar nada duas vezes.

Como funciona#

  1. O paciente chega por uma página do laboratório e vira um lead no CRM do Clube do Lab, com a origem registrada.
  2. O atendimento acontece no seu sistema, onde o orçamento é criado, alterado e fechado.
  3. A cada mudança, o seu sistema envia o estado do orçamento para a nossa API.
  4. Nós ligamos o orçamento ao lead certo pelo telefone ou e-mail do paciente. Quando não existe lead anterior, criamos um.

O que você precisa saber antes#

  • A API é de entrada: o seu sistema envia, nós recebemos. Não é preciso expor nenhum endpoint do seu lado.
  • O formato é um só para todos os sistemas (JSON sobre HTTPS), versionado pelo campo schemaVersion.
  • O envio é idempotente: reenviar o mesmo evento não duplica nada. Erro de rede se resolve reenviando.
  • Cada laboratório tem a sua chave de acesso. Um sistema que atende vários laboratórios usa uma chave por laboratório.

Como conseguir acesso#

A integração é liberada pela equipe do Clube do Lab, laboratório por laboratório. Fale com a gente informando o sistema e o laboratório. Você recebe uma chave de homologação para testar e, depois de validado, a chave de produção.

Por onde começar#

  1. Autenticação: endereços, chave e teste de conexão.
  2. Enviar eventos: o formato do envio.
  3. Regras de consistência: o que garante que os dados fiquem certos.
  4. Exemplos de código: um envio completo pronto para adaptar.