Visão geral

Introdução à API externa do LIP — base URL, versionamento, padrões de resposta e primeiros passos.

A API externa do LIP permite integrar WhatsApp, e-mail, CRM, conversas, flows, campanhas, mídia, landing pages e webhooks. Todas as rotas ficam abaixo de /api/external (recomendado: /api/external/v1).

Base URLhttps://external-api.lip7.com.br

Guia rápido

Autentique, crie um contato e dispare uma campanha WhatsApp.

Autenticação

API keys, escopos e as três formas de autenticar.

Quota e rate limit

O que consome cota mensal e os headers de limite.

CRM

Contatos, empresas, deals, pipelines e atividades.

Mensagens, templates, mídia e campanhas.

Conversas

Leitura e escrita de conversas, assign e notes.

Flows e execuções

Liste flows, dispare e cancele execuções em WAITING.

Webhooks

Eventos, deliveries, retry, test e rotate-secret.

Início rápido

Gere uma API key em Company › API & Webhooks com os escopos necessários.
Siga o Guia rápido (contato + campanha) ou envie uma mensagem de teste.
Acompanhe status em /usage/status/{requestId} ou cadastre um webhook.

Versionamento

/api/external/v1/* — recomendado para novas integrações
/api/external/* — alias legado, mesmo comportamento

Use sempre /v1

Os exemplos usam o alias legado por brevidade. Em produção, prefira /api/external/v1.

Estrutura das rotas

Domínio	Prefixo
Me / uso	`/api/external/v1/me`, `/usage/*`
Mídia	`/api/external/v1/media/*`
WhatsApp	`/api/external/v1/whatsapp/*`
Campanhas WhatsApp	`/api/external/v1/whatsapp/campaigns/*`
Conversas	`/api/external/v1/conversations/*`
E-mail	`/api/external/v1/email/*`
Flows	`/api/external/v1/flows/*`
Webhooks	`/api/external/v1/webhooks/*`
CRM	`/api/external/v1/contacts
Landing	`/api/external/v1/landing/*`

Padrão de resposta

Sucesso

{ "success": true, "data": {}, "message": "Opcional" }

Paginado

{
  "success": true,
  "data": [],
  "pagination": { "page": 1, "limit": 20, "total": 0, "totalPages": 0 }
}

Erro

{ "success": false, "error": "Mensagem", "code": "OPCIONAL" }

Veja Paginação, Erros e Idempotência.