Referência da API

API REST do Ecom

Uma API REST organizada em torno de recursos previsíveis, com respostas em JSON e códigos de status HTTP convencionais. A URL base é o subdomínio da sua loja (tenant).

URL base

https://minha-loja.ecom.app

Autenticação (Admin)

POST/auth/login
Login do painel
GET/auth/me
Usuário atual
PUT/auth/profile
Atualizar perfil
PUT/auth/password
Trocar senha
POST/auth/forgot-password
Esqueci a senha
POST/auth/logout
Logout do painel

Autenticação (Cliente)

POST/store-auth/register
Cadastrar cliente
POST/store-auth/login
Login do cliente
GET/store-auth/me
Perfil do cliente
POST/store-auth/magic-link/request
Solicitar magic link
POST/store-auth/magic-link/verify
Verificar magic link
POST/store-auth/social/{provider}/verify
Login social

Produtos

GET/products
Listar produtos
GET/products/{id}
Obter produto
POST/products
Criar produto
PUT/products/{id}
Atualizar produto
DELETE/products/{id}
Excluir produto
GET/products/{id}/variants
Listar variantes
POST/products/csv/import
Importar catálogo (CSV)

Pedidos

GET/orders
Listar pedidos
GET/orders/{id}
Obter pedido
PUT/orders/{id}
Atualizar pedido
POST/orders/{id}/etiqueta
Gerar etiqueta

Checkout & Loja

POST/store/checkout
Checkout
GET/store/orders
Meus pedidos
GET/store/orders/{id}
Detalhe do meu pedido
GET/store/loyalty/me
Meus pontos
POST/store/track
Evento de analytics
POST/store/newsletter-subscribe
Assinar newsletter

Pedido manual

GET/manual-orders
Listar pedidos manuais
POST/manual-orders
Criar pedido manual
PATCH/manual-orders/{id}
Atualizar pedido manual
POST/manual-orders/{id}/whatsapp
Enviar etapa por WhatsApp
POST/manual-orders/{id}/comprovante/whatsapp
Enviar comprovante

GET/whatsapp-config
Config de WhatsApp
PUT/whatsapp-config
Atualizar WhatsApp
POST/whatsapp/baileys/connect
Conectar via QR
GET/whatsapp/baileys/status
Status da conexão QR

Configurações

GET/settings
Configurações da loja
PUT/settings
Atualizar configurações
GET/shipping-config
Config de frete
POST/shipping-config/simulate
Simular frete

Plataforma

POST/platform/signup
Criar loja (signup)
GET/platform/signup/subdomain-available
Checar subdomínio
POST/platform/auth/login
Login super-admin
GET/platform/tenants
Listar tenants
GET/platform/tenants/{id}
Obter tenant

API pública v1

GET/api/v1/me
Identidade da chave
GET/api/v1/orders
Pedidos (pública)
GET/api/v1/orders/{id}
Pedido por id (pública)
GET/api/v1/products
Produtos (pública)
GET/api/v1/products/{id}
Produto por id (pública)

API REST do Ecom

Autenticação (Admin)

Autenticação (Cliente)

Produtos

Pedidos

Checkout & Loja

Pedido manual

WhatsApp

Configurações

Plataforma

API pública v1