Dinezy API

⚙️ Sistema 3

Monitoramento e configuração da API. O health-check é usado pelo Docker e load balancer para verificar se o serviço está saudável.

GET /up público

Retorna {"status":"up"} se o Laravel inicializou. Usado pelo Docker HEALTHCHECK.

GET /api/health-check público

Verifica se a API e suas dependências (DB, cache) estão operacionais.

GET /api/config público

Retorna configurações públicas da aplicação (versão, features habilitadas, etc).

🔐 Autenticação 5

Autenticação via Laravel Sanctum (token Bearer). O registro pode ser feito por formulário web (landing page) ou direto pela API.

POST /api/auth/login público

Login com e-mail e senha. Retorna token Sanctum e dados do usuário.

POST /api/auth/register público

Cadastro de novo usuário (cliente do restaurante).

POST /api/auth/register-restaurant público

Cadastro completo de restaurante via landing page (cria usuário owner + restaurante).

POST /api/auth/login-by-phone público

Login via código SMS enviado ao celular.

POST /api/auth/logout 🔑 Auth

Revoga o token Sanctum do usuário autenticado.

📋 Planos 6

Planos de assinatura disponíveis (Básico, Pro, Enterprise). Cada plano define preço, ciclo de cobrança e quais features estão habilitadas.

GET /api/plans público

Lista planos ativos com preço, ciclo e features incluídas.

GET /api/plans/{slug} público

Detalhes de um plano específico (ex: /api/plans/pro).

POST /api/plans 🔑 Auth

Cria plano. Requer role master.

PUT /api/plans/{slug} 🔑 Auth

Atualiza dados de um plano. Requer role master.

PATCH /api/plans/{slug}/toggle-status 🔑 Auth

Ativa ou desativa um plano sem removê-lo.

DELETE /api/plans/{slug} 🔑 Auth

Remove um plano sem assinaturas ativas vinculadas.

📊 Status do Plano 5

Consulta os limites e consumo do plano atual do restaurante autenticado. Usado internamente para bloquear ações que excedem o plano.

GET /api/plan-status 🔑 Auth

Retorna plano atual, features habilitadas e consumo do mês.

GET /api/plan-status/orders/check-limit 🔑 Auth

Verifica se o restaurante pode criar mais pedidos neste mês.

GET /api/plan-status/fiscal-documents/check-limit 🔑 Auth

Verifica se pode emitir mais NFC-e neste mês.

GET /api/plan-status/features/{feature}/check-access 🔑 Auth

Verifica se o plano inclui uma feature específica (ex: whatsapp_integration).

GET /api/features 🔑 Auth

Lista todas as features disponíveis na plataforma.

🔄 Assinaturas 6

Gerencia as assinaturas de um restaurante. A criação envia os dados ao billing-api (microserviço externo) que processa o pagamento no Asaas.

GET /api/restaurants/{slug}/subscriptions 🔑 Auth

Histórico de assinaturas do restaurante.

POST /api/restaurants/{slug}/subscriptions 🔑 Auth

Cria assinatura. Requer: plan_slug, payment_method, dados do cartão.

DELETE /api/subscriptions/restaurants/{slug} 🔑 Auth

Cancela assinatura ativa. Propagado ao Asaas de forma assíncrona.

GET /api/subscriptions/restaurants/{slug}/active 🔑 Auth

Retorna a assinatura ativa atual do restaurante. Requer role master.

GET /api/restaurants/{slug}/subscription/status 🔑 Auth

Status completo com plano, features e datas de vigência.

POST /api/billing/callback público

Webhook do billing-api. Atualiza status da assinatura automaticamente.

🍽️ Restaurante 8

Dados do restaurante: informações gerais, horários de funcionamento, configurações de pedido/mesa e SLA de entrega.

GET /api/restaurants/{slug} 🔑 Auth

Dados completos do restaurante (endereço, horários, configs).

PUT /api/restaurants/{slug} 🔑 Auth

Atualiza dados do restaurante (nome, logo, endereço, etc).

GET /api/restaurants/{slug}/hours 🔑 Auth

Lista horários de funcionamento regulares e especiais.

PUT /api/restaurants/{slug}/hours 🔑 Auth

Atualiza horários de funcionamento regulares.

GET /api/restaurants/{slug}/status público

Verifica se o restaurante está aberto agora (público).

PUT /api/restaurants/{slug}/sla 🔑 Auth

Atualiza tempos de SLA (preparo, entrega, retirada).

PUT /api/restaurants/{slug}/admin-order-settings 🔑 Auth

Configurações do painel de pedidos (som, notificações, etc).

PUT /api/restaurants/{slug}/table-settings 🔑 Auth

Configurações de mesas e comanda.

📖 Cardápio 9

Gerencia os cardápios do restaurante. Um restaurante pode ter múltiplos cardápios (almoço, jantar, fim de semana). O cardápio ativo é público.

GET /api/restaurants/{slug}/active público

Cardápio ativo público com produtos, categorias e disponibilidade.

GET /api/restaurants/{slug}/menus/{menuId} público

Detalhes de um cardápio específico (público).

GET /api/restaurants/{restaurant}/menus 🔑 Auth

Lista todos os cardápios.

POST /api/restaurants/{restaurant}/menus 🔑 Auth

Cria novo cardápio.

PUT /api/menus/{menu} 🔑 Auth

Atualiza dados de um cardápio.

DELETE /api/menus/{menu} 🔑 Auth

Remove cardápio.

GET /api/menus/{menu}/products 🔑 Auth

Lista produtos vinculados ao cardápio.

POST /api/menus/{menu}/products 🔑 Auth

Adiciona produtos ao cardápio.

DELETE /api/menus/{menu}/products/{product} 🔑 Auth

Remove produto do cardápio.

🛍️ Categorias & Produtos 9

Gerencia o catálogo de produtos do restaurante. Produtos pertencem a categorias e podem ter complementos (adicionais) e sugestões configuradas.

GET /api/restaurants/{restaurant}/categories 🔑 Auth

Lista categorias do restaurante.

POST /api/restaurants/{restaurant}/categories 🔑 Auth

Cria nova categoria.

PUT /api/categories/{category} 🔑 Auth

Atualiza categoria.

DELETE /api/categories/{category} 🔑 Auth

Remove categoria.

GET /api/restaurants/{restaurant}/products 🔑 Auth

Lista produtos com estoque, categorias e complementos.

POST /api/restaurants/{restaurant}/products 🔑 Auth

Cria produto (nome, preço, foto, categoria, complementos).

GET /api/products/{product} 🔑 Auth

Detalhes de um produto.

PUT /api/products/{product} 🔑 Auth

Atualiza produto.

DELETE /api/products/{product} 🔑 Auth

Remove produto.

📦 Estoque 7

Controle de estoque por produto. Registra entradas, saídas e ajustes. Alertas de estoque mínimo disponíveis via endpoint dedicado.

GET /api/restaurants/{slug}/stock 🔑 Auth

Visão geral do estoque do restaurante.

GET /api/restaurants/{slug}/stock/low-stock 🔑 Auth

Produtos abaixo do estoque mínimo configurado.

GET /api/products/{product}/stock 🔑 Auth

Estoque atual de um produto.

POST /api/products/{product}/stock/init 🔑 Auth

Inicializa controle de estoque com quantidade inicial.

POST /api/products/{product}/stock/movement 🔑 Auth

Registra movimento (entrada/saída/ajuste) com motivo.

PUT /api/products/{product}/stock/min-quantity 🔑 Auth

Define quantidade mínima para alerta de estoque baixo.

GET /api/products/{product}/stock/history 🔑 Auth

Histórico de movimentações do estoque.

🧾 Pedidos 9

Gerencia todo o ciclo de vida de um pedido — da criação pelo cliente até a entrega. Inclui deduplicação automática e notificação ao entregador.

POST /api/orders público

Cria pedido (público). Valida limites do plano e previne duplicatas.

GET /api/restaurants/{restaurant}/orders 🔑 Auth

Lista pedidos do restaurante com filtros (status, data, tipo).

GET /api/orders/{order} 🔑 Auth

Detalhes completos de um pedido com itens e histórico de status.

PUT /api/orders/{order} 🔑 Auth

Atualiza dados de um pedido.

PATCH /api/orders/{order}/status 🔑 Auth

Atualiza status (pending → confirmed → preparing → ready → delivered).

PATCH /api/orders/{order}/driver 🔑 Auth

Vincula entregador ao pedido.

PATCH /api/restaurants/{slug}/orders/{order}/mark-paid 🔑 Auth

Marca pedido como pago.

PATCH /api/restaurants/{slug}/orders/{order}/mark-unpaid 🔑 Auth

Marca pedido como não pago.

GET /api/restaurants/{slug}/orders/my-orders 🔑 Auth

Pedidos do cliente autenticado naquele restaurante.

🪑 Mesas 5

Sistema de comanda digital por mesa. O cliente escaneia o QR Code da mesa e abre uma sessão. O garçom acompanha e fecha a conta pelo painel.

POST /api/restaurants/{slug}/tables/{num}/session público

Abre ou retoma sessão de mesa via QR Code (público).

GET /api/restaurants/{slug}/tables 🔑 Auth

Lista todas as mesas e status atual de cada uma.

GET /api/restaurants/{slug}/tables/history 🔑 Auth

Histórico de sessões encerradas.

GET /api/restaurants/{slug}/tables/{num} 🔑 Auth

Detalhes de uma mesa e pedidos da sessão atual.

POST /api/restaurants/{slug}/tables/{num}/session/close 🔑 Auth

Fecha sessão da mesa (geração de conta).

🎟️ Clientes & Cupons 6

Gerencia a base de clientes do restaurante e cupons de desconto. Os cupons podem ter limite de uso, validade e valor fixo ou percentual.

GET /api/restaurants/{slug}/customers 🔑 Auth

Lista clientes com histórico de pedidos e total gasto.

POST /api/restaurants/{slug}/coupons/validate público

Valida um código de cupom (público — chamado no checkout).

GET /api/restaurants/{restaurant}/coupons 🔑 Auth

Lista cupons do restaurante.

POST /api/restaurants/{restaurant}/coupons 🔑 Auth

Cria cupom com código, tipo de desconto, validade e limites.

PUT /api/coupons/{coupon} 🔑 Auth

Atualiza cupom.

DELETE /api/coupons/{coupon} 🔑 Auth

Remove cupom.

🗺️ Bairros de Entrega 5

Define os bairros atendidos para delivery e o valor da taxa de entrega em cada um. Usado no checkout para validar e calcular o frete.

GET /api/restaurants/{slug}/neighborhoods 🔑 Auth

Lista bairros com taxa de entrega.

POST /api/restaurants/{slug}/neighborhoods 🔑 Auth

Adiciona bairro.

PUT /api/restaurants/{slug}/neighborhoods/{id} 🔑 Auth

Atualiza taxa ou nome do bairro.

PUT /api/restaurants/{slug}/neighborhoods 🔑 Auth

Atualiza múltiplos bairros em lote.

DELETE /api/restaurants/{slug}/neighborhoods/{id} 🔑 Auth

Remove bairro.

📣 Campanhas & WhatsApp 8

Envio de campanhas de marketing via WhatsApp para clientes. Requer integração ativa com a Evolution API e plano com feature whatsapp_integration.

GET /api/restaurants/{slug}/campaigns 🔑 Auth

Lista campanhas (rascunho, agendadas, enviadas).

POST /api/restaurants/{slug}/campaigns 🔑 Auth

Cria campanha com mensagem, público-alvo e agendamento.

POST /api/restaurants/{slug}/campaigns/{id}/send 🔑 Auth

Dispara campanha imediatamente.

POST /api/restaurants/{slug}/campaigns/{id}/cancel 🔑 Auth

Cancela campanha agendada.

GET /api/whatsapp/{slug} 🔑 Auth

Status da instância WhatsApp (conectado, QR pendente, etc).

POST /api/whatsapp 🔑 Auth

Cria instância WhatsApp para o restaurante.

GET /api/whatsapp/{slug}/connect 🔑 Auth

Gera QR Code para conectar o WhatsApp.

DELETE /api/whatsapp/{slug} 🔑 Auth

Desconecta e remove instância WhatsApp.

🧾 Nota Fiscal (NFC-e) 12

Emissão de NFC-e integrada à SEFAZ. Requer configuração prévia com CNPJ, certificado digital A1 e credenciais do provedor fiscal.

GET /api/restaurants/{slug}/fiscal-configuration 🔑 Auth

Configuração fiscal atual do restaurante.

POST /api/restaurants/{slug}/fiscal-configuration/register-company 🔑 Auth

Registra CNPJ e dados da empresa no provedor fiscal.

POST /api/restaurants/{slug}/fiscal-configuration/upload-certificate 🔑 Auth

Faz upload do certificado digital A1 (.pfx).

POST /api/restaurants/{slug}/fiscal-configuration/configure-nfce 🔑 Auth

Configura série e numeração da NFC-e.

POST /api/restaurants/{slug}/fiscal-configuration/activate 🔑 Auth

Ativa a emissão de NFC-e.

GET /api/restaurants/{slug}/fiscal-configuration/test-connection 🔑 Auth

Testa conexão com a SEFAZ.

GET /api/restaurants/{slug}/fiscal-documents 🔑 Auth

Lista notas fiscais emitidas com filtros.

POST /api/restaurants/{slug}/fiscal-documents/emit 🔑 Auth

Emite NFC-e a partir de um pedido.

GET /api/restaurants/{slug}/fiscal-documents/{id} 🔑 Auth

Detalhes de uma nota fiscal.

POST /api/restaurants/{slug}/fiscal-documents/{id}/cancel 🔑 Auth

Cancela NFC-e na SEFAZ.

GET /api/restaurants/{slug}/fiscal-documents/{id}/download/pdf 🔑 Auth

Download do DANFE em PDF.

GET /api/restaurants/{slug}/fiscal-documents/{id}/download/xml 🔑 Auth

Download do XML da nota fiscal.

📈 Analytics 3

Relatórios e métricas do restaurante. O relatório avançado requer plano com feature advanced_reports habilitada.

GET /api/restaurants/{slug}/analytics 🔑 Auth

Métricas do restaurante (faturamento, pedidos, ticket médio). Requer plano Pro+.

GET /api/restaurants/{slug}/analytics/stock 🔑 Auth

Relatório de estoque (giro, perdas, produtos sem movimentação).

GET /api/analytics/plans/dashboard 🔑 Auth

Dashboard geral de assinaturas e planos. Requer role master.

🚀 Onboarding & Tours 7

Guia o proprietário pelos primeiros passos após o cadastro (configurar cardápio, horários, etc). Os tours são tutoriais interativos dentro do painel.

GET /api/onboarding 🔑 Auth

Status do onboarding (etapas concluídas e próxima etapa).

GET /api/onboarding/steps 🔑 Auth

Lista todas as etapas do onboarding com descrição.

POST /api/onboarding/steps/{stepKey} 🔑 Auth

Marca uma etapa como concluída.

POST /api/onboarding/complete 🔑 Auth

Finaliza o onboarding.

GET /api/tours 🔑 Auth

Lista os tours disponíveis no painel.

POST /api/tours/{tourKey}/start 🔑 Auth

Inicia um tour interativo.

POST /api/tours/{tourKey}/complete 🔑 Auth

Marca tour como concluído.

Dinezy API

Endpoints

🔑 Autenticação

⚡ Stack técnica