Skip to main content

API Reference

Todos os endpoints da plataforma Labanana. Para testar ao vivo, use a documentacao interativa.

API Interativa

Swagger UI -- teste endpoints direto no browser | ReDoc -- documentacao navegavel


Catalogo (Admin)

Endpoints para configurar o catalogo de produtos. Requer role admin.

RecursoEndpointsDescricao
Product TypesPOST/GET/PATCH/DELETE /products/typesCategorias de produto
AssetsPOST /products/types/{id}/assets, PATCH/DELETE /products/assets/{id}Caracteristicas de fabricacao
OptionsPOST /products/types/{id}/options, PATCH/DELETE /products/options/{id}Caracteristicas visuais
VariantsPOST /products/types/{id}/variants, POST .../generate-variantsCombinacoes de assets com custo
TemplatesPOST /products/types/{id}/templates, upload via presignMockups para composicao

Operacoes bulk: Assets (/bulk), Variants (/bulk, /generate-variants, PATCH .../bulk, DELETE .../bulk)


Seller

Endpoints para sellers criarem e gerenciarem produtos. Requer autenticacao.

RecursoEndpointsDescricao
ArtworksPOST /uploads/artworks/presign, POST .../completeUpload de artes
Seller ProductsPOST/GET/PATCH/DELETE /seller-products/meCriar e gerenciar produtos
VariantesPOST /seller-products/me/{id}/variantsAdicionar variantes com preco
RendersPOST /seller-products/me/{id}/renderGerar mockups com arte
PlacementsGET/PUT /artworks/{id}/placements/{templateId}Posicionar arte no template
PreviewGET /seller-products/me/{id}/previewPre-visualizar pagina publica

Publico (sem autenticacao)

RecursoEndpointsDescricao
LojaGET /stores/{slug}/productsListar produtos da loja
ProdutoGET /stores/{slug}/products/{slug}Detalhe com SKUs, renders, definitions
ArtworkGET /artworks/public/{id}Detalhes publicos da arte

Auth

RecursoEndpointDescricao
SignupPOST /auth/signupCriar conta (retorna tokens)
LoginPOST /auth/loginAutenticar (retorna tokens)
RefreshPOST /auth/refreshRenovar tokens
MeGET /auth/meDados do usuario logado
SenhaPOST /auth/change-passwordAlterar senha
ResetPOST /auth/password/forgot, POST .../resetRecuperar senha

Detalhes completos: Autenticacao


Pedidos

RecursoEndpointDescricao
Criar pedidoPOST /ordersCheckout (requer auth)
PagarPOST /orders/{id}/payIniciar pagamento MercadoPago
Dev payPOST /orders/{id}/dev-paySimular pagamento (dev only)
ConsultarGET /orders/{id}Detalhe do pedido
Meus pedidosGET /orders/meListar pedidos do usuario
Seller itemsGET /orders/seller/itemsItens do seller
FulfillmentPATCH /orders/items/{id}/fulfillmentAtualizar status (admin)

Detalhes completos: Pedidos


Padrao de URLs

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.