Publicação no Stripe App Marketplace

Publicar o seu Stripe App no marketplace deixa o app disponível para todos os usuários do Stripe. Este guia cobre os requisitos, as etapas de preparação e o processo de envio.

Pré-requisitos

Antes de publicar um app no Stripe App Marketplace, você precisa atender a estes requisitos:

• Conta Stripe ativada: sua conta não pode estar limitada apenas ao modo de teste
• Um app por conta: cada conta Stripe só pode publicar um app público no marketplace
• Somente em inglês: todo o conteúdo do app, os textos da interface e as informações da listagem precisam estar em inglês
• App concluído: seu app precisa estar totalmente funcional e testado

Etapas de publicação

Etapa 1: atualize o seu manifesto

Defina o distribution_type do seu stripe-app.json como public:

{
  "id": "com.tajo.brevo-integration",
  "version": "1.0.0",
  "name": "Tajo Brevo Integration",
  "icon": "./icon.png",
  "distribution_type": "public",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Sync customer data to Brevo contacts"
    },
    {
      "permission": "customer_write",
      "purpose": "Update customer metadata with Brevo sync status"
    },
    {
      "permission": "event_read",
      "purpose": "Track payment and subscription events for Brevo automation"
    }
  ]
}

Etapa 2: prepare o seu app

Confirme que o seu app atende a todos os requisitos de revisão antes de enviá-lo:

1. Teste bem o app nos modos live e sandbox
2. Verifique se todas as permissões são necessárias e estão documentadas
3. Confirme que o tratamento de erros e os estados de carregamento foram implementados
4. Confira se todos os textos da interface estão em inglês

Etapa 3: envie o seu app

Use a Stripe CLI para enviar o seu app:

# Upload your app to Stripe
stripe apps upload

# Verify the upload
stripe apps versions list

Etapa 4: escreva a sua listagem

Vá até o Stripe Dashboard para completar a listagem do seu app. Todos os campos da listagem são obrigatórios para o envio ao marketplace.

Etapa 5: envie para revisão

Depois de completar a listagem, envie o app para revisão pelo Stripe Dashboard. A equipe do Stripe vai avaliar o seu app de acordo com os requisitos de qualidade.

Etapa 6: publique

Assim que for aprovado, você pode publicar o app para deixá-lo disponível no marketplace.

Configuração do manifesto para distribuição pública

O manifesto precisa incluir distribution_type: "public" e declarar todas as permissões necessárias com descrições de finalidade claras:

{
  "id": "com.tajo.brevo-integration",
  "version": "1.2.0",
  "name": "Tajo for Brevo",
  "icon": "./assets/icon.png",
  "distribution_type": "public",
  "stripe_api_access_type": "oauth",
  "allowed_redirect_uris": [
    "https://tajo.io/stripe/callback"
  ],
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Read customer profiles to sync with Brevo contacts"
    },
    {
      "permission": "customer_write",
      "purpose": "Write sync metadata to customer records"
    },
    {
      "permission": "charge_read",
      "purpose": "Access payment data for Brevo event tracking"
    },
    {
      "permission": "event_read",
      "purpose": "Subscribe to Stripe events for real-time Brevo sync"
    },
    {
      "permission": "product_read",
      "purpose": "Sync product catalog to Brevo for campaign personalization"
    },
    {
      "permission": "invoice_read",
      "purpose": "Track invoice events for Brevo transactional emails"
    }
  ],
  "ui_extension": {
    "views": [
      {
        "viewport": "stripe.dashboard.customer.detail",
        "component": "CustomerDetailView"
      },
      {
        "viewport": "stripe.dashboard.home.overview",
        "component": "OverviewView"
      }
    ]
  },
  "post_install_action": {
    "type": "onboarding"
  }
}

Envie o app já configurado com:

stripe apps upload

Requisitos da listagem

A listagem do seu app precisa incluir todos os campos a seguir:

Diretrizes para o nome

• Precisa ser único no marketplace
• Deve identificar com clareza a finalidade do seu app
• Evite termos genéricos que possam confundir os usuários
• Exemplo: “Tajo for Brevo” (15 caracteres)

Diretrizes para o ícone

• Dimensões: exatamente 300x300 pixels
• Formato: PNG ou SVG
• Não adicione cantos arredondados, o Stripe os aplica automaticamente
• Use um logotipo ou símbolo claro e reconhecível
• Garanta a legibilidade em tamanhos pequenos

Seção About

Escreva uma descrição convincente que cubra:

• Qual problema o seu app resolve
• Os principais recursos de integração
• Para quem o app foi feito
• Quaisquer pré-requisitos ou exigências

Exemplo:

A Tajo for Brevo conecta os dados de pagamento do seu Stripe à plataforma de automação de marketing da Brevo. Sincronize clientes automaticamente, acompanhe eventos de pagamento e dispare campanhas personalizadas de e-mail, SMS e WhatsApp com base no comportamento de compra em tempo real. Feita para negócios de e-commerce que querem maximizar o valor de vida útil do cliente com marketing de retenção guiado por dados.

Principais recursos

Cada item de recurso principal inclui:

• Título: nome curto do recurso
• Descrição: uma ou duas frases explicando o recurso
• Imagem: captura de tela ou diagrama (recomendado 1600x900 pixels)

Recursos recomendados para a integração da Tajo com a Brevo:

1. Sincronização de clientes em tempo real, sincronize automaticamente os perfis de clientes do Stripe com os contatos da Brevo, com todo o histórico de compras
2. Automação orientada a eventos, dispare fluxos da Brevo a partir de eventos do Stripe, como pagamentos aprovados, mudanças de assinatura e reembolsos
3. Sincronização do catálogo de produtos, mantenha o catálogo de produtos da Brevo sincronizado com o Stripe para personalizar o conteúdo das campanhas
4. Campanhas multicanal, use os dados sincronizados para alimentar campanhas segmentadas de e-mail, SMS e WhatsApp
5. Insights no Dashboard, veja as métricas de engajamento da Brevo direto na visão de cliente do Stripe Dashboard

Informações de preço

Comunique com clareza o seu modelo de preços:

• Gratuito: sem custo para instalar ou usar
• Pago: informe o preço e a frequência de cobrança
• Freemium: descreva o que está incluído de graça e o que exige pagamento
• Por uso: explique as faixas de preço ou os custos por unidade

Teste do seu app

Antes de enviar, teste o seu app a fundo:

Teste no modo sandbox

# Start your app in test mode
stripe apps start --mode test

# Verify sandbox compatibility
stripe apps validate

Formato das credenciais de teste

Ao fornecer credenciais de teste para o time de revisão, use este formato:

Test Account Credentials
========================
Platform: Tajo
URL: https://app.tajo.io/test
Email: [email protected]
Password: [secure test password]

Brevo Test API Key: xkeysib-test-xxxxxxxxxxxx

Required Setup Steps:
1. Log in to the Tajo test account
2. Navigate to Settings > Integrations > Brevo
3. The Brevo API key is pre-configured
4. Install the Stripe App from the test link provided

Expected Behavior:
- Customer sync should begin within 60 seconds of installation
- Navigate to any Stripe customer to see Brevo contact data
- Create a test payment to verify event sync to Brevo

Checklist de revisão

Antes de enviar, verifique:

• O app funciona nos modos live e de teste
• Todas as permissões têm descrições de finalidade claras
• Os estados de erro são tratados com elegância
• Os estados de carregamento aparecem nas operações assíncronas
• Não há dados de teste fixos no código do build de produção
• A URL da política de privacidade está acessível e correta
• As informações de contato do suporte são válidas
• Todas as imagens da listagem atendem aos requisitos de dimensão
• A descrição do app reflete com precisão o funcionamento

Depois do envio

O time de revisão do Stripe costuma responder em 5 a 10 dias úteis. Ele pode:

• Aprovar o seu app para publicação
• Solicitar mudanças com um retorno específico
• Rejeitar o app se ele não atender aos requisitos

Se mudanças forem solicitadas, atenda a todo o retorno e envie de novo. Cada reenvio passa pelo ciclo de revisão completo.

Atualização de um app publicado

Para atualizar um app já publicado:

1. Aumente a versão no stripe-app.json
2. Envie a nova versão: stripe apps upload
3. Envie a atualização para revisão
4. Assim que for aprovada, a atualização é implantada automaticamente para todos os usuários