Pular para o conteúdo principal
Versão: Next

Referência de Endpoints

Esta seção é um guia curado dos endpoints mais usados, com exemplos prontos. Para a lista exaustiva e executável, use o Swagger.

Convenções​

  • Base URL: https://api.mockmerce.com.br/v1 (produção) ou http://localhost:3333/v1 (local).
  • Headers de negócio: X-API-Key (obrigatório) e X-Student-RM (recomendado).
  • Ações do cliente logado: somam Authorization: Bearer <token>.
  • Paginação: rotas de lista aceitam page e pageSize (máx. 100) e devolvem { data, page, pageSize, total }.
  • Erros: sempre { "error": { "code", "message" } }.
GET/health

Healthcheck simples (sem /v1, sem auth): retorna { "status": "ok" }.

Índice por área​

ÁreaConteúdoPágina
CatálogoProdutos, variantes, categoriasCatálogo
MídiaUpload de fotos e vídeos (S3), biblioteca da lojaCatálogo
AvaliaçõesEstrelas, comentário e fotos de quem comprouCatálogo
LocalizaçãoPontos de retirada, distância e mapa do rastreioLocalização e mapa
Carrinho & PedidosCarrinho, checkout, pagamentoCarrinho e Pedidos
Loja (aluno)Login do aluno, config, chaves, membrosLoja/Aluno
WebhooksRegistrar, testar e listar entregasWebhooks
Badges de método

Ao longo destas páginas, o método HTTP aparece assim:

GETPOSTPUTPATCHDELETE