DevCod Ícone DevCod
/ Docs
ESTA DOCUMENTAÇÃO ESTÁ EM DESENVOLVIMENTO E CONSTANTE ATUALIZAÇÃO.

API Reference

Referência técnica completa dos endpoints de backend, contratos de dados e webhooks do sistema DevCod Agency.

Visão Geral

A API do DevCod é estruturada como um conjunto de rotas HTTP protegidas por controle de escopo multi-tenant e limite de requisições. O sistema opera com segurança integrada por padrão na borda. 

{`
URLs de Acesso:
- Produção:       https://seudominio.com/api
- Desenvolvimento: http://localhost:3000/api
          `}

Autenticação e Segurança

A maioria das rotas do painel administrativo exige autenticação obrigatória via Middleware JWT:

  • Cookie de Sessão: Autenticação via cookie admin-session seguro.
  • Isolamento Multi-Tenant: O middleware valida a sessão e injeta o header x-site-id de forma segura para rotear as transações do banco de dados (RLS).
  • Anti-CSRF: Recomenda-se o uso do cliente fetchWithCsrf para mutações de estado (POST, PUT, DELETE) com validação de tokens baseados em Double-Submit.

Formato Padrão de Resposta

Todas as respostas da API seguem a assinatura estruturada:

{`
{
  "data": {},        // Payload de dados da requisição
  "error": null,     // String de erro ou null caso sucesso
  "meta": {
    "timestamp": "2026-05-05T12:00:00Z"
  }
}
          `}

Rotas de CRM (Leads e Contatos)

Endpoints para gestão do funil e contatos:

Método Endpoint Validação (Zod Schema) Descrição
GET /api/admin/crm/contacts listContactsSchema (cursor, segmentId) Listar contatos paginados do tenant
POST /api/admin/crm/contacts createEmailContactSchema Criar contato individualmente
POST /api/admin/crm/contacts/import importContactsSchema (max 100k char) Importação em lote de e-mails em texto
POST /api/leads createLeadSchema (Público) Captura externa de leads (Smart Forms)

Rotas de E-mail Marketing

Endpoints para gerenciamento de campanhas e pixel-tracking:

Método Endpoint Autenticação Descrição
POST /api/admin/email/campanhas JWT Admin Enviar ou agendar campanhas de e-mail
GET /api/email/track Público Pixel de abertura (retorna imagem 1x1)
GET /api/email/click Público Pixel de cliques em links de e-mails
GET /api/email/unsubscribe Público Página e ação de descadastramento

Rotas de Webhooks e Integração

Pontos de entrada HTTP para integrações externas em tempo real:

Método Endpoint Headers Requeridos Descrição
POST /api/webhooks/hotmart X-Hotmart-Signature (HMAC SHA256) Ingestão de eventos de vendas e assinaturas
POST /api/webhooks/resend Assinatura do webhook DevCod Mail Atualiza logs de bounces, spams e entregas
Próximo: Design System →