Pular para o conteúdo principal

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.

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
Galeria (fotos)POST/PATCH/DELETE /seller-products/me/{id}/images, POST .../reorderFotos manuais do produto (multipart)
Avatar/BannerPOST /profiles/seller/me/upload-url, POST .../upload-complete, DELETE .../image/{type}Imagens de perfil do seller (presign)

Publico (sem autenticacao)

RecursoEndpointsDescricao
Home feedGET /discovery/homeBestsellers + curated + featured artists (home publica)
LojaGET /stores/{slug}Detalhe da loja (com contadores de follow/like)
Loja (produtos)GET /stores/{slug}/productsListar produtos da loja
ProdutoGET /stores/{slug}/products/{slug}Detalhe com SKUs, renders, definitions
ArtworkGET /artworks/public/{id}Detalhes publicos da arte
WaitlistPOST /waitlist, POST /waitlist/invite/validateInscricao publica + validacao de token

Auth

RecursoEndpointDescricao
SignupPOST /auth/signupCriar conta (retorna tokens)
Signup sellerPOST /auth/signup/sellerCompletar cadastro via invite token
LoginPOST /auth/loginAutenticar (retorna tokens)
RefreshPOST /auth/refreshRenovar tokens
MeGET /auth/meDados do usuario logado
Atualizar perfilPATCH /users/meNome + CPF/CNPJ (obrigatorio para checkout)
SenhaPOST /auth/change-passwordAlterar senha
ResetPOST /auth/password/forgot, POST .../resetRecuperar senha

Detalhes completos: Autenticacao


Pedidos

RecursoEndpointDescricao
Criar pedidoPOST /ordersCheckout — ja cria o pagamento no Asaas e retorna initPoint
Retry pagarPOST /orders/{id}/payGerar novo link de pagamento (preference expirou)
Dev payPOST /orders/{id}/dev-paySimular pagamento aprovado (dev only)
ConsultarGET /orders/{id}Detalhe do pedido
Meus pedidosGET /orders/meListar pedidos do usuario
Listar todosGET /ordersAdmin — todos os pedidos com filtros
Pedidos do sellerGET /orders/seller/me, GET .../seller/itemsPedidos/itens do seller autenticado
FulfillmentPATCH /orders/items/{id}/fulfillmentAtualizar status do item (admin)
ReembolsoPOST /orders/{id}/refundTotal ou parcial via Asaas (admin)
CancelarPOST /orders/{id}/cancelCancelar — se pago, emite refund total (admin)

Detalhes completos: Pedidos


Admin — Usuarios e Waitlist

Endpoints administrativos. Todos exigem role admin.

RecursoEndpointsDescricao
UsuariosPOST/GET /users, GET /users/{id}, POST .../suspend, POST .../activateCRUD + suspensao
RolesPOST/DELETE /users/{id}/roles/{role}Adicionar/remover role (customer/seller/admin)
WaitlistGET /waitlist, GET /waitlist/{id}, PATCH /waitlist/{id}Listar e gerenciar inscricoes
Waitlist acoesPOST /waitlist/{id}/invite, .../reject, .../blockGerar invite / rejeitar / bloquear
PayoutsPOST /payouts, GET /payouts/{id}, PATCH .../mark-paid, PATCH .../mark-failedBatches 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.