VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Marketplace de módulos

Como a loja descobre, instala e avalia módulos (recursos opcionais da plataforma) e o mapa das rotas do administrador.

A plataforma é dividida em módulos: recursos que a loja liga conforme a necessidade (KYC de sellers, moderação de produtos, representantes comerciais, integrações). O marketplace de módulos é o catálogo desses recursos: você navega, instala o que quer usar, remove o que não quer e deixa uma avaliação. Instalar um módulo é o que faz as rotas dele deixarem de responder 403 module_disabled.

Pontos-chave
  • Todas as rotas exigem o privilégio manage_modules ou manage_settings.
  • A instalação vale para a loja do token (o tenant). Você nunca informa o id da loja.
  • Instalar um módulo liga também as dependências dele, recursivamente. Remover é recusado se outro módulo instalado depende dele.
  • A plataforma pode vetar a instalação ou a remoção de um módulo específico para a sua loja (403). Isso é decisão da Venddor, não do administrador da loja.
  • Cada módulo mostra o seu estado na loja em install_status: not_installed, installed_enabled ou installed_disabled.
  • Módulos descontinuados, restritos a outra loja ou bloqueados para a sua não aparecem no catálogo. A lista de instalados também esconde os recursos nativos e os conectores de canal de venda.

Como funciona

Descobrir→Instalar→Usar as rotas do módulo→(opcional) Avaliar ou Remover
  1. Descobrir

    Liste o catálogo filtrando por categoria ou texto, e abra o detalhe do módulo para ver dependências, preço e changelog.

  2. Instalar

    Instale pelo slug. As dependências são ligadas junto. O cache de módulos da loja é invalidado na hora, então as rotas do módulo passam a responder em seguida.

  3. Avaliar

    Deixe uma avaliação de 1 a 5. Cada loja tem uma avaliação por módulo.

Conceitos-chave

Slug

O slug (por exemplo vendor-kyc) identifica o módulo em todas as rotas. É o mesmo nome que aparece em {"error":"module_disabled","module":"vendor-kyc"}.

Preço

pricing_type é free, premium ou enterprise. price_cents é inteiro em centavos (0 para gratuitos). min_plan indica o plano mínimo da loja, quando existe.

Estado e acesso

Uma loja pode ter o acesso a um módulo restrito pela Venddor (por exemplo, sem permissão de instalar). Nesse caso a instalação responde 403 com tenant does not have permission to install module <slug>.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/marketplace/modulesListar o catálogoadmin
GET/api/v1/admin/marketplace/modules/{slug}Detalhe de um móduloadmin
GET/api/v1/admin/marketplace/categoriesCategoriasadmin
GET/api/v1/admin/marketplace/installedMódulos instaladosadmin
POST/api/v1/admin/marketplace/install/{slug}Instalaradmin
DELETE/api/v1/admin/marketplace/uninstall/{slug}Removeradmin
POST/api/v1/admin/marketplace/modules/{slug}/reviewAvaliaradmin
GET/api/v1/admin/marketplace/modules/{slug}/reviewsLer avaliaçõesadmin

Erros comuns

  • Esperar um corpo na instalação. A rota não lê corpo nem configuração. Reinstalar um módulo já instalado regrava a configuração dele como vazia.
  • Confundir slug com id. Todas as rotas usam o slug, nunca o id UUID.
  • Ler installed_only=true como paginado. Com esse filtro a lista vem inteira, sem paginação, e page/per_page são ignorados.
  • Remover um módulo que outro usa. Devolve 400 citando os módulos que dependem dele.
  • Enviar avaliação e receber 401. Veja o aviso na página de avaliações: hoje essa rota responde 401 mesmo com token válido.
  • Chamar a rota do módulo antes de instalar. Responde 403 module_disabled.

Próximos passos

Navegar o catálogo
Listar, filtrar e ver detalhes.
Instalar e remover
Ligar e desligar módulos da loja.
Erros da API
O formato de erro comum a todas as rotas.
Anterior
Canais de venda
Próxima
Navegar o catálogo de módulos
Nesta página
  • Como funciona
  • Conceitos-chave
  • Slug
  • Preço
  • Estado e acesso
  • Endpoints
  • Erros comuns
  • Próximos passos