Guia do produto e da API

Modelos do Marketplace

O que os designs prontos oferecem

O Marketplace oferece designs iniciais do PDFgine para propostas, relatórios, apresentações e documentos similares. Depois de adicionar um modelo ao espaço de trabalho, você pode editar texto, dados, cores e layout no Gerador.

Por enquanto, apenas o PDFgine publica modelos no Marketplace. Não há fluxo de publicação para clientes venderem seus próprios modelos.

Tipos de acesso

  • Grátis: um usuário com a permissão necessária pode adicionar o modelo diretamente ao espaço de trabalho.
  • Incluído no plano: não há cobrança extra quando o plano de assinatura ativo inclui o modelo.
  • Pago: o modelo pode ser instalado no espaço de trabalho correspondente após a verificação do pagamento único.

Obter e usar um modelo

  1. Encontre um design por categoria ou pesquisa e confira sua capa e descrição.
  2. Adicione um modelo gratuito ou incluído no plano, ou conclua o pagamento seguro de um design pago.
  3. A instalação adiciona uma cópia editável do design à seção Modelos do espaço de trabalho selecionado.
  4. Abra no Gerador, substitua os dados de exemplo pelos seus e verifique PDF, Word e Visualizador antes de publicar.

O código do modelo deve ser exclusivo no espaço de trabalho. Uma colisão nunca sobrescreve o modelo existente; você deve escolher outro código.

Publicar e instalar pela API

Tudo o que a tela do marketplace faz está disponível por endpoints: listar o que está publicado, copiar um modelo para sua conta, publicar um dos seus e definir seu preço.

cURL
# Listar o que está publicado
curl -s "https://api.pdfgine.com/api/v1/marketplace/templates?locale=en" \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Copiar um para sua própria conta
curl -X POST https://api.pdfgine.com/api/v1/marketplace/templates/consulting-proposal/install \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "code": "proposal", "name": "Proposta" }'

# Publicar um dos seus
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/marketplace \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "title": "Fatura com condições de pagamento",
        "summary": "Um modelo de faturamento com condições de pagamento e um bloco de totais.",
        "category": "reports",
        "locale": "en",
        "license": "commercial",
        "visibility": "public",
        "confirmAssetRedistributionRights": true
      }'

# Definir o preço - priceMinorUnits é obrigatório quando isFree é false
curl -X PUT https://api.pdfgine.com/api/v1/marketplace/templates/invoice-with-payment-terms/offer \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "isFree": false,
        "priceMinorUnits": 4900,
        "currency": "USD",
        "includedPlanCodes": ["business", "enterprise"],
        "expectedVersion": 3
      }'

A instalação copia o modelo para sua conta; alterações posteriores do publicador não afetam sua cópia. A publicação pede que você confirme o direito de redistribuir as fontes e imagens do modelo; essa confirmação é registrada.

Seus próprios gráficos e modelos

Criar seu próprio modelo ou gráfico não exige compra no Marketplace. O que é vendido é o design pronto preparado pelo PDFgine.

Abrir Marketplace →

Os problemas mais comuns

  • A instalação copia o design para seu espaço de trabalho. Alterações posteriores do publicador não chegam a essa cópia, e suas edições também nunca são sobrescritas.
  • O código deve estar disponível no seu espaço de trabalho. Uma colisão nunca sobrescreve seu modelo; a instalação é recusada e pede outro código.
  • Atualmente, apenas o PDFgine publica. Os endpoints de publicação e oferta respondem 403 para espaços sem a função de publicador, então ainda não crie um fluxo de vendedor com eles.
  • O cursor da listagem inclui os filtros. Alterar search, category ou locale mantendo before retorna 400 de propósito; o mesmo cursor apontaria para outra lista.
  • Um design pago só é instalado após a verificação do pagamento. Chamar install antes de checkout gera uma recusa, não uma fila.