Guia da API | RV Store API

Buscar endpoint

Filtre por URL, método ou responsabilidade para encontrar a documentação rapidamente.

Seção

Endpoints públicos

Sem autenticação

GET

/api/produtos

GET

/api/produtos/{slug}

GET

/api/categorias

GET

/api/banners

GET

/api/promocoes/ativas

Seção

Autenticação

POST

/api/auth/register

POST

/api/auth/login

POST / GET

/api/auth/logout · /api/auth/me · /api/auth/refresh

POST

/api/password/forgot · /api/password/reset

Seção

Cliente

Bearer + role:cliente

GET · PUT · POST · DELETE

/api/perfil

GET · POST · PUT · DELETE · PATCH

/api/enderecos

Gerencia a lista de endereços do cliente e marca um endereço como padrão.

POST /api/enderecos

nome_destinatario, telefone, provincia, municipio, bairro, rua, referencia

PUT /api/enderecos/{id}

nome_destinatario, telefone, provincia, municipio, bairro, rua, referencia

Campos de endereço

nome_destinatario (string, obrigatório)
telefone (string, obrigatório)
provincia (string, obrigatório)
municipio (string, obrigatório)
bairro (string, opcional)
rua (string, opcional)
referencia (string, opcional)

Notas

PATCH /api/enderecos/{id}/padrao troca apenas o endereço padrão, sem body adicional.

GET · POST · PUT · DELETE

/api/carrinho

POST · GET

/api/checkout · /api/pedidos

GET · POST

/api/wishlist · /api/produtos/{id}/avaliar

GET · PATCH

/api/notificacoes

Seção

Admin

Bearer + role:admin,super_admin

GET · POST · PUT · DELETE

/api/admin/produtos

Cria, atualiza, lista, visualiza e remove produtos com proteção de administrador.

POST / PUT

code, nome, slug, descricao, id_categoria, preco, old_price, ativo, destaque

GET / DELETE

Lista, mostra e remove produto por id.

Campos de produto

code (string, obrigatório)
nome (string, obrigatório)
slug (string, opcional, único)
id_categoria (integer, obrigatório)
preco (numeric, obrigatório)
old_price (numeric, opcional)
ativo (boolean, opcional)
destaque (boolean, opcional)

Importante

Rotas admin exigem header Authorization: Bearer {token} e role:admin ou super_admin.

GET · POST · PUT · DELETE

/api/admin/categorias

GET · POST · PUT · DELETE

/api/admin/banners

GET · POST · PUT · DELETE

/api/admin/promocoes

GET · POST · PUT · DELETE

/api/admin/cupons

GET · POST · PUT · DELETE

/api/admin/configuracoes

GET · POST · PUT · DELETE

/api/admin/usuarios

GET · POST · PUT · DELETE

/api/admin/produto-imagens

GET · POST · PUT · DELETE

/api/admin/produto-variacoes

GET · PATCH

/api/admin/pedidos

Observações

Dicas práticas

Responsividade e uso leve

Como consumir

Use o token retornado no login em Authorization: Bearer.
Requisições públicas não exigem autenticação.
Verifique o role:cliente nas rotas protegidas.

Sugestão de integração

Carregue listagens de produtos em /api/produtos.
Use /api/produtos/{slug} para página de detalhes.
Atualize o carrinho com endpoints de /api/carrinho e aplique cupom por /api/carrinho/cupom.