Integração API

A API de integração é a API REST do LeadSim para conectar sistemas da sua empresa (ERP, site, CRM, BI) à sua conta. Com ela, um sistema seu cria leads, consulta o funil, emite propostas e contratos, confere o financeiro e emite notas, sem passar pelas telas.

Esta seção é para quem desenvolve essa integração. O restante do manual descreve as telas para quem usa o LeadSim no dia a dia.

Como funciona

• Chave própria. Cada usuário gera a própria chave (lsk_api_...) e a envia no header Authorization de cada requisição. Veja Sua chave de API.
• Mesmas permissões do usuário. A chave faz exatamente o que o usuário dono faz nas telas: mesmos menus, funis e restrições. Registros criados pela API ficam em nome dele.
• Uma chave ativa por usuário. Gerar uma nova revoga a anterior na hora.
• Só as rotas documentadas. A chave alcança as 165 rotas da Referência de rotas. Qualquer outra rota do LeadSim responde 403.
• Controle do administrador. Quem pode gerar chave é definido pelo perfil, e o administrador vê todas as chaves da empresa, o uso e revoga o que precisar.

O que dá para fazer

CRM

Módulo	O que cobre
Funil	Funis de venda e suas etapas.
Captura de leads	Contato e oportunidade criados numa chamada só.
Contatos	Pessoas, endereços, tags e anotações.
Oportunidades	Negócios do funil, com contatos, produtos e anotações.
Atividades	Tarefas, agenda e tipos de atividade.
Cadastros	Produtos, canais de venda, segmentos e motivos de ganho e perda.

Vendas e faturamento

Módulo	O que cobre
Propostas	Propostas comerciais, PDF e envio.
Contratos	Contratos, produtos, faturamento, vencimento e PDF.
Assinatura digital	Envio de contratos para assinatura pela Autentique.
Financeiro	Lançamentos, cobranças, baixas e reenvio.
Notas fiscais	NFS-e: emissão, PDF, XML, e-mail e cancelamento.

Por onde começar

Você é	Comece por
Desenvolvedor da integração	Sua chave de API, Autenticação e convenções e Primeira requisição
Quem vai montar um fluxo ponta a ponta	Fluxos comuns e a Referência de rotas

Ambientes

Ambiente	Endereço base	Swagger	Este guia
Produção	https://api.plus.leadsim.com.br	/api/documentation/	/docs/api/
Homologação	https://api.plus.qa.leadsim.com.br	/api/documentation/	/docs/api/

A chave de um ambiente só vale nele: gere uma chave na conta de homologação para testar e outra na conta de produção para a integração definitiva.

Testar sem escrever código

O Swagger lista as mesmas rotas desta referência e executa chamadas no navegador. Cole a sua chave em Authorize e teste cada rota antes de programar.