Visão Geral da API

Base URL

https://<domínio>/api

A API é construída em Laravel e organizada em quatro grupos de rotas:

Prefixo	Público	Guard
/api/admin	Painel do lojista	admin (JWT)
/api/client	App do cliente	client (JWT)
/api/master	Administração da plataforma	master (JWT)
/api/site	Páginas públicas / SEO	—

Autenticação

Todos os endpoints protegidos exigem o header:

Authorization: Bearer <token>

Os tokens são JWTs gerados no login. Ver autenticacao.md.

Roles (Permissões)

Os usuários admin possuem roles que controlam o acesso a recursos específicos:

Role	Recursos liberados
delivery-order	Pedidos de delivery
board-order	Mesas / comandas
cash-register	Caixa
product	Produtos e categorias
setting	Configurações da loja
restaurant-state	Abrir/fechar loja e cozinha
account	Dados cadastrais do restaurante

Planos

Alguns recursos são protegidos por plano contratado:

• board — módulo de mesas/comandas

Formato de Resposta

Todas as respostas bem-sucedidas seguem o padrão JSON. Erros seguem o formato documentado em erros.md.

Health Check

GET /api

Resposta:

{ "status": "OK" }