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) ouhttp://localhost:3333/v1(local). - Headers de negócio:
X-API-Key(obrigatório) eX-Student-RM(recomendado). - Ações do cliente logado: somam
Authorization: Bearer <token>. - Paginação: rotas de lista aceitam
pageepageSize(máx.100) e devolvem{ data, page, pageSize, total }. - Erros: sempre
{ "error": { "code", "message" } }.
GET
/healthHealthcheck simples (sem /v1, sem auth): retorna { "status": "ok" }.
Índice por área
| Área | Conteúdo | Página |
|---|---|---|
| Catálogo | Produtos, variantes, categorias | Catálogo |
| Mídia | Upload de fotos e vídeos (S3), biblioteca da loja | Catálogo |
| Avaliações | Estrelas, comentário e fotos de quem comprou | Catálogo |
| Localização | Pontos de retirada, distância e mapa do rastreio | Localização e mapa |
| Carrinho & Pedidos | Carrinho, checkout, pagamento | Carrinho e Pedidos |
| Loja (aluno) | Login do aluno, config, chaves, membros | Loja/Aluno |
| Webhooks | Registrar, testar e listar entregas | Webhooks |
Badges de método
Ao longo destas páginas, o método HTTP aparece assim:
GETPOSTPUTPATCHDELETE