Documentação da API

A API do app.smart conecta o CRM ao resto do seu negócio — site, e-commerce, ERP, BI, automações no-code. Esta página é o índice da documentação.

Comece por aqui

Se é seu primeiro contato:

1. Introdução — o que dá pra fazer e o que não dá
2. Autenticação — gerar token e usar
3. Quickstart — primeira requisição em 5 minutos
4. Convenções — paginação, filtros, ordenação, erros
5. Rate limits — quotas por endpoint
6. CORS — chamadas direto do navegador

Casos de uso

Os cenários mais comuns explicados passo a passo:

• Lead do formulário do site cai no CRM
• Registrar conversão com Meta CAPI
• Etiquetar e segmentar contatos
• Sincronizar contatos com sistema externo (ERP, planilha)
• Integrar com Zapier, Make ou n8n

Referência por recurso

Os endpoints expostos, organizados por entidade:

Comunicação

• Conversations — conversas
• Messages — listar mensagens individuais (read-only)

CRM

• Contacts — base de contatos
• Custom Attributes — campos personalizados
• Labels — etiquetas
• Segments — segmentação dinâmica
• Notes — anotações em contatos

Funil de vendas

• Deals — negócios
• Pipelines — funis e fases (read-only)

Atribuição e marketing

• Conversion Events — eventos de conversão (Lead, Purchase, Meta CAPI)

Notificações

• Webhooks — configurar endpoints de notificação

Webhooks

Pra receber eventos em tempo real do app.smart:

• Introdução
• Configurar webhook
• Segurança do webhook
• Eventos disponíveis
• Estrutura de payloads
• Entrega e falhas

Base URL

Toda chamada à API segue o padrão:

https://app.smart2.com.br/api/v1/accounts/{account_id}/...

• app.smart2.com.br — host (mesmo do painel)
• v1 — versão atual da API
• {account_id} — ID da sua conta (visível na URL ao acessar o painel)

Convenções resumidas

• HTTPS obrigatório — chamadas em HTTP são bloqueadas
• JSON em request e response
• UTF-8 em qualquer string
• ISO 8601 para datas (2026-05-24T14:30:00Z)
• Headers padrão — api_access_token (auth) e Content-Type: application/json

Detalhes em Convenções.

Mudanças e versionamento

• Versão atual: v1, na URL (/api/v1/...)
• Campo novo e endpoint novo entram em v1 sem aviso — o seu código deve ignorar o que não conhece
• Mudança que quebra é avisada no changelog antes de entrar
• Não existe e-mail automático de deprecation nem cabeçalho Sunset: o aviso é o changelog

Suporte

• Bug em endpoint? Abra ticket com nome do endpoint, payload enviado e response recebido
• Sugestão? Fale com nossa equipe pelo canal de suporte
• Quer contribuir com exemplos? Compartilhe seu caso real com a gente