Guia de integração com Stripe Apps
Os Stripe Apps permitem incorporar funcionalidades personalizadas diretamente no Stripe Dashboard. Esta seção é um guia de construção: ela documenta como um app desse tipo para a integração entre a Tajo e a Brevo seria construído, testado e publicado.
Caution
Status: ainda não publicado. Não existe hoje nenhum app da Tajo no Stripe App Marketplace, e os identificadores de app, URLs e credenciais destas páginas são exemplos ilustrativos, não endpoints reais. Para conectar o Stripe à Tajo agora, use o conector Stripe (chave de API restrita, sincronização somente leitura).
Tip
O objetivo é publicar uma integração com a Brevo no Stripe App Marketplace, permitindo que lojistas do Stripe sincronizem dados de clientes, pedidos e eventos diretamente na Brevo para automação de marketing e CRM.
O que são Stripe Apps?
Os Stripe Apps estendem o Stripe Dashboard com componentes de interface personalizados e integrações de backend. Eles permitem que desenvolvedores externos:
- Adicionem visualizações personalizadas a páginas do Stripe Dashboard (clientes, pagamentos, faturas etc.)
- Acessem dados do Stripe por meio de permissões delimitadas
- Sincronizem dados entre o Stripe e plataformas externas como a Brevo
- Ofereçam fluxos de inicialização e configuração dentro do Dashboard
Objetivos da integração Tajo + Brevo
O Stripe App da Tajo conecta o Stripe à Brevo para entregar:
- Inteligência de clientes: sincronize perfis de clientes, histórico de pagamentos e valor de vida útil do Stripe para os contatos da Brevo
- Rastreamento de eventos: envie eventos do Stripe (pagamentos, assinaturas, reembolsos) como eventos transacionais da Brevo
- Campanhas automatizadas: acione campanhas de e-mail, SMS e WhatsApp da Brevo com base na atividade no Stripe
- Programas de fidelidade: crie fluxos de retenção usando dados de compra do Stripe sincronizados com a Brevo
Visão geral da arquitetura
Conteúdo do guia
Esta documentação cobre o ciclo de vida completo de construção e publicação de um Stripe App:
Primeiros passos
| Guia | Descrição |
|---|---|
| Publicação no Marketplace | Requisitos e etapas para enviar seu app para revisão |
| Requisitos de revisão do app | Padrões de qualidade, segurança e experiência de uso para aprovação |
Configuração e referência
| Guia | Descrição |
|---|---|
| Referência do manifesto do app | Esquema completo do arquivo de manifesto stripe-app.json |
| Referência de permissões | Lista completa de permissões da API do Stripe e como solicitá-las |
| Referência de viewports | Locais do Dashboard onde a interface do seu app pode aparecer |
Recursos e integração
| Guia | Descrição |
|---|---|
| Stripe Apps incorporados | Uso de componentes incorporados do Connect para integrações de plataforma |
| Links de instalação e deep links | Gere URLs de instalação e deep links para telas específicas do app |
| Ações pós-instalação | Configure fluxos de inicialização depois da instalação do app |
Operação e crescimento
| Guia | Descrição |
|---|---|
| Analytics do app | Acompanhe instalações, visualizações e métricas de conversão |
| Ecossistema de parceiros | Aproveite o programa de parceiros do Stripe para co-marketing e crescimento |
Pré-requisitos
Antes de construir um Stripe App, garanta que você tem:
- Conta Stripe: uma conta Stripe ativada (não restrita ao modo de teste)
- Stripe CLI: instale a Stripe CLI para desenvolvimento local e envio do app
- Node.js: versão 16 ou posterior para a extensão de interface do app
- Acesso à plataforma Tajo: conta Tajo ativa com as credenciais da API da Brevo configuradas
Início rápido
# Install Stripe CLIbrew install stripe/stripe-cli/stripe
# Login to your Stripe accountstripe login
# Create a new Stripe App projectstripe apps create tajo-brevo-integration
# Start local developmentstripe apps startConceitos principais
Manifesto do app
Todo Stripe App tem um manifesto stripe-app.json que declara permissões, viewports e configuração. Veja a Referência do manifesto do app para o esquema completo.
Extensões de interface
Os Stripe Apps podem renderizar componentes de interface em React em viewports específicos do Dashboard. O kit de interface oferece componentes prontos que seguem o design system do Stripe Dashboard.
Permissões
Os apps precisam declarar os recursos específicos da API do Stripe que querem acessar. Os usuários aprovam essas permissões durante a instalação. Veja a Referência de permissões.
Segredo de assinatura
Cada app recebe um segredo de assinatura para verificar assinaturas de instalação e proteger a comunicação entre o seu backend e o Stripe.
Fluxo de desenvolvimento
- Defina seu manifesto com as permissões e os viewports necessários
- Construa a extensão de interface usando a biblioteca de componentes React do Stripe
- Implemente os endpoints de backend para sincronizar dados com a Brevo via Tajo
- Teste localmente com
stripe apps start - Envie com
stripe apps upload - Submeta para revisão pelo Stripe Dashboard
- Publique e acompanhe pelo analytics
Caution
O Stripe exige que os apps sejam escritos em inglês para distribuição no marketplace. A descrição do seu app, os textos da interface e a documentação precisam estar todos em inglês.
Próximos passos
Comece pelo Guia de publicação para entender todos os requisitos e depois percorra as referências técnicas para configurar o manifesto e as permissões do seu app.