Introdução
A API Linkari é REST, versionada e fala JSON. Toda funcionalidade que aparece na interface está disponível também via API. Sem cobrança extra, sem módulo separado.
Base URL
https://api.linkari.ia.br/v1
Formato
JSON em request e response. UTF-8 padrão. Datas em ISO 8601.
Segurança
HTTPS obrigatório. TLS 1.3. Bearer token no header.
Autenticação
Cada chamada inclui sua API key no header Authorization. Crie chaves no painel em Configurações → API → Nova chave. Escopos por chave: leitura, contato, envio em canal específico — você decide o que cada integração pode fazer.
💡 Boa prática: use chaves diferentes por ambiente (test/live) e por integração. Drawer por chave mostra os últimos 100 requests com status e tempo — descobre quem integrou o quê e quando.
Quickstart · enviar uma mensagem
Em 4 linhas você dispara uma mensagem WhatsApp. Escolha sua linguagem favorita:
Playground interativo
Cole sua API key, escolha o endpoint, ajuste os parâmetros e dispare a requisição direto do navegador. O playground gera o código em curl, JavaScript, PHP e Python — copia e cola pronto.
🚧 Playground completo disponível no painel /api/docs (após criar sua conta)
Contatos
CRUD completo. Filtros por origem, tag, custom field, pipeline.
Mensagens
Enviar mensagens em qualquer canal. Anexos, templates HSM, polls e mídia.
Conversas
Pipelines & Cards
Workflows
Webhooks
Receba notificações em tempo real de eventos: nova mensagem, mudança de stage, conversa atribuída, lead qualificado pela IA, e mais.
Eventos disponíveis
- 📨
message.created - 📨
message.delivered - 📨
message.read - 💬
conversation.opened - 💬
conversation.closed - 👤
contact.created - 📌
card.moved - 🤖
ai.intent_detected - 🔥
lead.temperature_changed
Garantias
- ✓ Retry automático em caso de falha (3 tentativas)
- ✓ Assinatura HMAC SHA-256 no header
- ✓ Idempotência via
event_id - ✓ Histórico completo no painel
- ✓ Replay manual de eventos
SDKs oficiais
Bibliotecas mantidas pela Linkari, com tipos, autocomplete e exemplos.
JavaScript
npm i @linkari/sdk
PHP
composer require linkari/sdk
Python
pip install linkari
Ruby
gem install linkari em breve
Rate Limits
Generoso o suficiente pra tráfego real, rígido o suficiente pra impedir uma integração mal-feita derrubar seu Linkari.
Headers X-RateLimit-Limit e X-RateLimit-Remaining em toda resposta. Status 429 quando exceder.
Códigos de erro
Changelog da API
Mudanças incompatíveis são versionadas (/v2, /v3). Versão atual: v1.
Webhook ai.intent_detected. Endpoint /v1/cards/{id}/comments.
SDK Python lançado. Suporte a anexos múltiplos em POST /messages/media.
Lançamento da API REST com endpoints de Contatos, Mensagens, Conversas, Pipelines e Workflows.