Skip to main content

Integração com a Plataforma de CRM

Bem-vindo à documentação oficial de integração com nossa API.
Aqui você encontrará tudo que precisa para conectar seu sistema ao nosso CRM de gestão de clientes, contratos e financeiro, utilizado por franquias e empresas parceiras.

A integração é organizada em três partes principais:

📌 Etapas da Integração​

1. API REST (Rotas de Consulta e Criação)​

Oferecemos um conjunto completo de rotas RESTful para que seu sistema possa consultar, criar e atualizar dados relacionados a:

  • Clientes
  • Contratos
  • Planos e serviços
  • Vendedores
  • Informações de pets
  • Franquias

As rotas estão organizadas por domínio de negócio e são autenticadas via Bearer Token (OAuth2).

2. Webhooks que seu sistema deve nos enviar​

Para garantir a consistência entre os sistemas, esperamos que você nos envie eventos via webhook sempre que certas ações ocorrerem do seu lado.

Por exemplo:

  • Cancelamento de contrato
  • Alteração de status financeiro
  • Atualização de dados relevantes

Esses webhooks devem seguir nosso padrão de autenticação e estrutura de payload.
📄 Veja a lista completa em Webhooks.

3. Fluxos completos entre os sistemas​

Alguns processos envolvem ida e volta entre os sistemas. Exemplo:

  • Nosso frontend dispara um evento de alteração de vencimento
  • Seu sistema processa
  • E retorna a confirmação via webhook

Chamamos isso de fluxo completo, e todos esses processos estão descritos com:

  • Sequência dos passos
  • Diagrama de comunicação
  • Exemplos de payload
  • Regras de negócio

📄 Acesse a seção Fluxos Completos para ver todos os processos documentados.

🛡️ Autenticação​

Todas as requisições à API devem conter um Bearer Token válido.

Veja como obter e utilizar esse token na seção Autenticação.

🤝 Suporte​

Em caso de dúvidas, erros de integração ou sugestões, entre em contato com nossa equipe técnica pelo e-mail:

📧 marco.rocha@lakstech.com.br

✅ Vamos Começar?​

Navegue pelos tópicos no menu lateral para iniciar a integração!