Referência de rotas
As 165 rotas que a chave de API acessa, agrupadas por módulo. Cada rota mostra parâmetros, corpo e respostas; o botão Testar no Swagger abre a mesma rota no Swagger, onde dá para executar a chamada com a sua chave.
Antes de usar, leia Autenticação e convenções.
CRM
| Módulo | Rotas | O que cobre |
|---|---|---|
| Atividades | 18 | Tarefas, agenda e tipos de atividade. |
| Cadastros | 18 | Produtos, canais de venda, segmentos e motivos de ganho e perda. |
| Captura de leads | 2 | Contato e oportunidade criados numa chamada só. |
| Contatos | 18 | Pessoas, endereços, tags e anotações. |
| Funil | 11 | Funis de venda e suas etapas. |
| Oportunidades | 31 | Negócios do funil, com contatos, produtos e anotações. |
Vendas e faturamento
| Módulo | Rotas | O que cobre |
|---|---|---|
| Assinatura digital | 6 | Envio de contratos para assinatura pela Autentique. |
| Contratos | 21 | Contratos, produtos, faturamento, vencimento e PDF. |
| Financeiro | 14 | Lançamentos, cobranças, baixas e reenvio. |
| Notas fiscais | 10 | NFS-e: emissão, PDF, XML, e-mail e cancelamento. |
| Propostas | 16 | Propostas comerciais, PDF e envio. |