Tema
Todos os Endpoints
Lista completa de endpoints agrupados por módulo.
Saúde
| Método | Path | Auth | Descrição |
|---|---|---|---|
GET | /health | Público | Health check básico |
GET | /admin/health | Super Admin | Health detalhado com dependências |
Usuários (/users)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /users/me | Auth | Perfil atual |
GET | /users | app:team | Lista usuários |
POST | /users/invite | app:team | Convite |
PATCH | /users/:id/role | app:team | Altera papel |
DELETE | /users/:id | app:team | Remove usuário |
POST | /users/:id/reset-password | app:team | Reset de senha |
POST | /users/bootstrap-sync | Super Admin | Sync com Clerk |
Papéis (/config/roles)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /config/roles | app:roles | Lista papéis |
GET | /config/roles/:id | app:roles | Detalhes |
POST | /config/roles | app:roles | Criar |
PATCH | /config/roles/:id | app:roles | Atualizar |
DELETE | /config/roles/:id | app:roles | Deletar |
Configurações (/settings)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /settings/store | app:settings | Loja padrão |
POST | /settings/store | app:settings | Atualiza loja |
GET | /settings/stores | app:settings | Lista lojas |
GET | /settings/stores/:id/business-hours | app:settings | Horários |
PUT | /settings/stores/:id/business-hours | app:settings | Define horários |
PATCH | /settings/stores/:id/ecommerce | app:settings | Toggle e-commerce |
GET | /settings/email | app:integrations | Config email |
POST | /settings/email | app:integrations | Salva email config |
GET | /settings/whatsapp | app:integrations | Lista instâncias WA |
POST | /settings/whatsapp | app:integrations | Adiciona instância |
PATCH | /settings/whatsapp/:id | app:integrations | Atualiza instância |
DELETE | /settings/whatsapp/:id | app:integrations | Remove instância |
POST | /settings/whatsapp/onboarding/exchange | app:integrations | OAuth Meta |
GET | /settings/smtp | app:integrations | SMTP da org |
POST | /settings/smtp | app:integrations | Salva SMTP |
POST | /settings/smtp/test | app:integrations | Testa SMTP |
GET | /settings/org | Auth | Logo e nome |
PATCH | /settings/org | Auth | Atualiza logo |
GET | /settings/campaign | Auth | Settings de campanha |
PATCH | /settings/campaign | Auth | Atualiza settings |
Aliases de loja (/config/store-aliases)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /config/store-aliases | app:store-aliases | Lista aliases |
PATCH | /config/store-aliases/:id | app:store-aliases | Define principal |
DELETE | /config/store-aliases/:id/alias | app:store-aliases | Remove alias |
WhatsApp (/whatsapp)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /webhooks/whatsapp | Público | Hub verification |
POST | /webhooks/whatsapp | Público (HMAC) | Webhook Meta |
POST | /whatsapp/:storeId/templates | app:integrations | Criar template |
GET | /whatsapp/:storeId/templates | app:integrations | Listar templates |
POST | /whatsapp/:storeId/templates/sync | app:integrations | Sync da Meta |
PATCH | /whatsapp/:storeId/templates/:id | app:integrations | Editar template |
DELETE | /whatsapp/:storeId/templates/:id | app:integrations | Deletar template |
POST | /whatsapp/:storeId/template-images | app:integrations | Upload imagem (5MB) |
GET | /whatsapp/analytics | Auth | Analytics de campanha |
GET | /whatsapp/monitoring | app:integrations | Monitoramento |
GET | /whatsapp/:storeId/account-info | app:integrations | Info da conta Meta |
GET | /whatsapp/:storeId/rate-limit | app:integrations | Rate limit status |
GET | /whatsapp/:storeId/conversations | app:integrations | Lista conversas |
GET | /whatsapp/:storeId/conversations/:id/messages | app:integrations | Mensagens |
POST | /whatsapp/:storeId/conversations/:id/messages | app:integrations | Enviar reply |
Chatwoot
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /whatsapp/chatwoot/config | app:integrations | Config do Chatwoot |
POST | /whatsapp/chatwoot/config | app:integrations | Salva config |
GET | /whatsapp/chatwoot/health | app:integrations | Health da integração |
GET | /whatsapp/chatwoot/inboxes | app:integrations | Lista inboxes |
POST | /whatsapp/chatwoot/inboxes | app:integrations | Cria inbox |
PATCH | /whatsapp/chatwoot/inboxes/:id | app:integrations | Atualiza inbox |
POST | /webhooks/chatwoot | Público (interno) | Webhook do Chatwoot |
Campanhas (/campaigns)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /campaigns | app:campaigns | Lista campanhas |
GET | /campaigns/realtime | app:campaigns | Métricas em tempo real |
GET | /campaigns/whatsapp-analytics | app:campaigns | Analytics WhatsApp |
GET | /campaigns/email-analytics | app:campaigns | Analytics Email |
GET | /campaigns/estimate | app:campaigns | Estimativa de audiência |
GET | /campaigns/:id | app:campaigns | Detalhes da campanha |
GET | /campaigns/:id/rate-limit-check | app:campaigns | Verificação rate limit |
POST | /campaigns | app:campaigns:send | Criar campanha |
PATCH | /campaigns/:id | app:campaigns:send | Atualizar |
DELETE | /campaigns/:id | app:campaigns:send | Deletar |
POST | /campaigns/:id/duplicate | app:campaigns:send | Duplicar |
POST | /campaigns/:id/send | app:campaigns:send | Disparar |
POST | /campaigns/:id/test | app:campaigns:send | Teste WhatsApp |
POST | /campaigns/:id/test-email | app:campaigns:send | Teste Email |
Email Templates (/email-templates)
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /email-templates | app:campaigns | Lista templates |
GET | /email-templates/merge-fields | app:campaigns | Campos de merge |
GET | /email-templates/:id | app:campaigns | Detalhes |
POST | /email-templates | app:campaigns | Criar |
PATCH | /email-templates/:id | app:campaigns | Atualizar |
DELETE | /email-templates/:id | app:campaigns | Deletar |
POST | /email-templates/:id/duplicate | app:campaigns | Clonar |
POST | /email-templates/:id/thumbnail | app:campaigns | Upload thumbnail |
Email Tracking (público)
| Método | Path | Descrição |
|---|---|---|
GET | /email-tracking/t/:id.png | Pixel de abertura |
GET | /email-tracking/c/:id | Clique em link |
GET | /email-tracking/u/:id | Página unsubscribe |
POST | /email-tracking/u/:id | Unsubscribe RFC 8058 |
CRM / Inteligência
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /crm/intelligence/rfm | app:segments | Distribuição RFM |
GET | /crm/intelligence/filters | app:segments | Opções de filtro |
GET | /crm/intelligence/segments | app:segments | Lista segmentos |
GET | /crm/intelligence/segments/:id | app:segments | Detalhes |
GET | /crm/intelligence/segments/:id/export | app:export | Export CSV |
POST | /crm/intelligence/segments | app:segments | Criar |
PUT | /crm/intelligence/segments/:id | app:segments | Atualizar |
PATCH | /crm/intelligence/segments/:id/status | app:segments | Toggle ativo |
DELETE | /crm/intelligence/segments/:id | app:segments | Deletar |
POST | /crm/intelligence/preview | app:segments | Preview audiência |
GET | /rfm/overview | Auth | Overview RFM |
GET | /rfm/migrations | Auth | Matriz de migração |
POST | /rfm/recompute | Auth | Recomputar RFM |
Qualidade de dados
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /crm/quality/summary | app:sales | Resumo geral |
GET | /crm/quality/performance | app:sales | Por loja |
GET | /crm/quality/seller-performance | app:sales | Por vendedor |
GET | /crm/quality/transactions | app:sales | Transações com flags |
Pesquisa pós-venda
| Método | Path | Auth | Descrição |
|---|---|---|---|
GET | /public/survey/load-sale | Público | Carrega pesquisa pelo token |
GET | /public/survey/template-sale | Público | Template público |
POST | /public/survey/respond-sale | Público | Submete resposta |
GET | /crm/post-sale-survey/config | app:integrations | Configs CSAT/NPS |
PUT | /crm/post-sale-survey/config/:type | app:integrations | Cria/atualiza config |
GET | /crm/post-sale-survey/results | app:integrations | Dashboard de resultados |
GET | /crm/post-sale-survey/jobs | app:integrations | Jobs paginados |
Pesquisa de satisfação (pós-atendimento)
| Método | Path | Auth | Descrição |
|---|---|---|---|
POST | /public/survey/respond | Público | Submete resposta |
GET | /survey/results | app:integrations | Resultados |
GET | /survey/window-expiry | app:integrations | Janelas expiradas |
ERP / Sync
| Método | Path | Permissão | Descrição |
|---|---|---|---|
POST | /erp/sync/trigger | app:integrations | Trigger manual |
GET | /erp/sync/status | app:integrations | Status do sync |
GET | /erp/customers | app:customers | Lista clientes |
GET | /erp/customers/:id | app:customers | Detalhes do cliente |
PATCH | /erp/customers/:id/preferences | app:customers | Atualiza preferências |
POST | /erp/customers/import-optout | app:integrations | Import opt-out bulk |
GET | /erp/sales/dashboard | app:sales | Dashboard de vendas |
GET | /erp/sales/transactions | app:sales | Transações |
POST | /erp/sales | Internal API Key | Registra venda (ERP) |
Redirecionamento (público)
| Método | Path | Descrição |
|---|---|---|
GET | /go/:token | Resolve redirect de campanha |
GET | /go/unsubscribe/:token | Opt-out WhatsApp |
Auditoria
| Método | Path | Permissão | Descrição |
|---|---|---|---|
GET | /audit/logs | app:audit | Logs de auditoria |
GET | /audit/stats | app:audit | Estatísticas |
Admin (Super Admin apenas)
| Método | Path | Descrição |
|---|---|---|
GET | /admin/health | Health detalhado |
GET | /admin/metrics | Métricas da aplicação |
GET | /admin/logs | Logs recentes |
GET | /admin/containers | Status dos containers |
POST | /admin/containers/:name/restart | Restart de container |
POST | /admin/queue/retry-failed | Retry de jobs falhos |
DELETE | /admin/queue/completed | Limpa jobs completos |
POST | /admin/queue/pause | Pausa fila de sync |
POST | /admin/queue/resume | Resume fila de sync |
POST | /admin/whatsapp/sync-pricing | Sync de preços WA |
POST | /admin/whatsapp/sync-chatwoot-names | Sync de nomes Chatwoot |
n8n (Internal API Key)
| Método | Path | Descrição |
|---|---|---|
POST | /integrations/whatsapp/n8n/agent-reply | Reply de agente |
POST | /integrations/whatsapp/n8n/conversation-resolved | Conversa resolvida |
POST | /integrations/whatsapp/n8n/register-campaign-reply | Reply de campanha |
POST | /integrations/whatsapp/n8n/register-conversion | Conversão |
POST | /integrations/whatsapp/n8n/sync-failure | Falha de sync |
POST | /integrations/whatsapp/n8n/update-message-status | Status de mensagem |