API Reference
Todos os endpoints da plataforma Labanana. Para testar ao vivo, use a documentacao interativa.
:::tip API Interativa Swagger UI -- teste endpoints direto no browser | ReDoc -- documentacao navegavel :::
Catalogo (Admin)
Endpoints para configurar o catalogo de produtos. Requer role admin.
| Recurso | Endpoints | Descricao |
|---|---|---|
| Product Types | POST/GET/PATCH/DELETE /products/types | Categorias de produto |
| Assets | POST /products/types/{id}/assets, PATCH/DELETE /products/assets/{id} | Caracteristicas de fabricacao |
| Options | POST /products/types/{id}/options, PATCH/DELETE /products/options/{id} | Caracteristicas visuais |
| Variants | POST /products/types/{id}/variants, POST .../generate-variants | Combinacoes de assets com custo |
| Templates | POST /products/types/{id}/templates, upload via presign | Mockups para composicao |
Operacoes bulk: Assets (/bulk), Variants (/bulk, /generate-variants, PATCH .../bulk, DELETE .../bulk)
Seller
Endpoints para sellers criarem e gerenciarem produtos. Requer autenticacao.
| Recurso | Endpoints | Descricao |
|---|---|---|
| Artworks | POST /uploads/artworks/presign, POST .../complete | Upload de artes |
| Seller Products | POST/GET/PATCH/DELETE /seller-products/me | Criar e gerenciar produtos |
| Variantes | POST /seller-products/me/{id}/variants | Adicionar variantes com preco |
| Renders | POST /seller-products/me/{id}/render | Gerar mockups com arte |
| Placements | GET/PUT /artworks/{id}/placements/{templateId} | Posicionar arte no template |
| Preview | GET /seller-products/me/{id}/preview | Pre-visualizar pagina publica |
| Galeria (fotos) | POST/PATCH/DELETE /seller-products/me/{id}/images, POST .../reorder | Fotos manuais do produto (multipart) |
| Avatar/Banner | POST /profiles/seller/me/upload-url, POST .../upload-complete, DELETE .../image/{type} | Imagens de perfil do seller (presign) |
Publico (sem autenticacao)
| Recurso | Endpoints | Descricao |
|---|---|---|
| Home feed | GET /discovery/home | Bestsellers + curated + featured artists (home publica) |
| Loja | GET /stores/{slug} | Detalhe da loja (com contadores de follow/like) |
| Loja (produtos) | GET /stores/{slug}/products | Listar produtos da loja |
| Produto | GET /stores/{slug}/products/{slug} | Detalhe com SKUs, renders, definitions |
| Artwork | GET /artworks/public/{id} | Detalhes publicos da arte |
| Waitlist | POST /waitlist, POST /waitlist/invite/validate | Inscricao publica + validacao de token |
Auth
| Recurso | Endpoint | Descricao |
|---|---|---|
| Signup | POST /auth/signup | Criar conta (retorna tokens) |
| Signup seller | POST /auth/signup/seller | Completar cadastro via invite token |
| Login | POST /auth/login | Autenticar (retorna tokens) |
| Refresh | POST /auth/refresh | Renovar tokens |
| Me | GET /auth/me | Dados do usuario logado |
| Atualizar perfil | PATCH /users/me | Nome + CPF/CNPJ (obrigatorio para checkout) |
| Senha | POST /auth/change-password | Alterar senha |
| Reset | POST /auth/password/forgot, POST .../reset | Recuperar senha |
Detalhes completos: Autenticacao
Pedidos
| Recurso | Endpoint | Descricao |
|---|---|---|
| Criar pedido | POST /orders | Checkout — ja cria o pagamento no Asaas e retorna initPoint |
| Retry pagar | POST /orders/{id}/pay | Gerar novo link de pagamento (preference expirou) |
| Dev pay | POST /orders/{id}/dev-pay | Simular pagamento aprovado (dev only) |
| Consultar | GET /orders/{id} | Detalhe do pedido |
| Meus pedidos | GET /orders/me | Listar pedidos do usuario |
| Listar todos | GET /orders | Admin — todos os pedidos com filtros |
| Pedidos do seller | GET /orders/seller/me, GET .../seller/items | Pedidos/itens do seller autenticado |
| Fulfillment | PATCH /orders/items/{id}/fulfillment | Atualizar status do item (admin) |
| Reembolso | POST /orders/{id}/refund | Total ou parcial via Asaas (admin) |
| Cancelar | POST /orders/{id}/cancel | Cancelar — se pago, emite refund total (admin) |
Detalhes completos: Pedidos
Admin — Usuarios e Waitlist
Endpoints administrativos. Todos exigem role admin.
| Recurso | Endpoints | Descricao |
|---|---|---|
| Usuarios | POST/GET /users, GET /users/{id}, POST .../suspend, POST .../activate | CRUD + suspensao |
| Roles | POST/DELETE /users/{id}/roles/{role} | Adicionar/remover role (customer/seller/admin) |
| Waitlist | GET /waitlist, GET /waitlist/{id}, PATCH /waitlist/{id} | Listar e gerenciar inscricoes |
| Waitlist acoes | POST /waitlist/{id}/invite, .../reject, .../block | Gerar invite / rejeitar / bloquear |
| Payouts | POST /payouts, GET /payouts/{id}, PATCH .../mark-paid, PATCH .../mark-failed | Batches de saque (cross-seller NAO existe) |
Detalhes: Admin — Usuarios · Onboarding do Seller · Dashboard do Seller
Padrao de URLs
:::info Convencao
- Criacao/Listagem: aninhado sob o recurso pai --
POST /products/types/{id}/assets - CRUD individual: flat com ID --
PATCH /products/assets/{id} - Seller: prefixo
/me--GET /seller-products/me - Admin: prefixo
/admin--GET /products/templates/admin/all:::
Autenticacao
Todas as requests autenticadas usam:
Authorization: Bearer <accessToken>
Tokens obtidos via POST /auth/login ou POST /auth/signup.