Stripe Apps 集成指南
Stripe Apps 允许您将自定义功能直接嵌入到 Stripe Dashboard 中,让商家无需离开支付工作流程即可访问 Tajo 的 Brevo 集成。本指南涵盖构建、测试和发布通过 Tajo 连接 Stripe 与 Brevo 的 Stripe App 所需的一切。
Tip
目标是在 Stripe App Marketplace 上发布 Brevo 集成,使 Stripe 商家能够将客户数据、订单和事件直接同步到 Brevo 中,用于营销自动化和 CRM。
什么是 Stripe Apps?
Stripe Apps 通过自定义 UI 组件和后端集成扩展 Stripe Dashboard。它们允许第三方开发者:
- 向 Stripe Dashboard 页面(客户、支付、发票等)添加自定义视图
- 通过范围权限访问 Stripe 数据
- 在 Stripe 与 Brevo 等外部平台之间同步数据
- 在 Dashboard 中提供引导和配置流程
Tajo + Brevo 集成目标
Tajo Stripe App 将 Stripe 与 Brevo 连接起来,提供:
- Customer Intelligence:将 Stripe 客户档案、支付历史和终身价值同步到 Brevo 联系人
- Event Tracking:将 Stripe 事件(支付、订阅、退款)推送为 Brevo 交易事件
- Automated Campaigns:根据 Stripe 活动触发 Brevo 电子邮件、短信和 WhatsApp 营销活动
- Loyalty Programs:使用同步到 Brevo 的 Stripe 购买数据构建留存工作流
架构概述
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐│ Stripe Dashboard │────▶│ Tajo Platform │────▶│ Brevo ││ (Stripe App UI) │◀────│ (Middleware) │◀────│ (CRM/Email) │└─────────────────┘ └─────────────────┘ └─────────────────┘ │ │ │ Customer views Data sync & Contacts, Payment details Event routing Campaigns, App settings Webhook handling Automations指南内容
本文档涵盖构建和发布 Stripe App 的完整生命周期:
入门
| 指南 | 描述 |
|---|---|
| 发布到 Marketplace | 提交应用审核的要求和步骤 |
| 应用审核要求 | 获得批准的质量、安全和 UX 标准 |
配置与参考
| 指南 | 描述 |
|---|---|
| App Manifest 参考 | stripe-app.json manifest 文件的完整架构 |
| 权限参考 | 完整的 Stripe API 权限列表及请求方式 |
| Viewports 参考 | 应用 UI 可以显示的 Dashboard 位置 |
功能与集成
| 指南 | 描述 |
|---|---|
| Embedded Stripe Apps | 使用 Connect 嵌入式组件进行平台集成 |
| Install Links & Deep Links | 生成安装 URL 并深度链接到特定应用视图 |
| Post-Install Actions | 配置应用安装后的引导流程 |
运营与增长
| 指南 | 描述 |
|---|---|
| 应用分析 | 跟踪安装、浏览量和转化指标 |
| 合作伙伴生态系统 | 利用 Stripe 合作伙伴计划进行联合营销和增长 |
前提条件
在构建 Stripe App 之前,请确保您具备:
- Stripe 账户:已激活的 Stripe 账户(不限于测试模式)
- Stripe CLI:安装 Stripe CLI 用于本地开发和应用上传
- Node.js:版本 16 或更高,用于应用 UI 扩展
- Tajo Platform 访问权限:已配置 Brevo API 凭据的活跃 Tajo 账户
快速开始
# 安装 Stripe CLIbrew install stripe/stripe-cli/stripe
# 登录到您的 Stripe 账户stripe login
# 创建新的 Stripe App 项目stripe apps create tajo-brevo-integration
# 开始本地开发stripe apps start核心概念
App Manifest
每个 Stripe App 都有一个 stripe-app.json manifest 文件,用于声明权限、视口和配置。请参阅 App Manifest 参考 了解完整架构。
UI Extensions
Stripe Apps 可以在特定 Dashboard 视口中渲染基于 React 的 UI 组件。UI 工具包提供与 Stripe Dashboard 设计系统相匹配的预构建组件。
Permissions
应用必须声明所需访问的特定 Stripe API 资源。用户在安装过程中批准这些权限。请参阅 权限参考。
Signing Secret
每个应用都会收到一个签名密钥,用于验证安装签名并保护您的后端与 Stripe 之间的通信安全。
开发工作流程
- 定义 manifest,包含所需的权限和视口
- 构建 使用 Stripe React 组件库的 UI 扩展
- 实现 通过 Tajo 与 Brevo 数据同步的后端端点
- 测试 使用
stripe apps start进行本地测试 - 上传 使用
stripe apps upload - 提交 通过 Stripe Dashboard 进行审核
- 发布 并通过分析监控
Caution
Stripe 要求应用必须以英文编写才能在 marketplace 分发。您的应用列表、UI 文本和文档都必须使用英文。
后续步骤
从 发布指南 开始,了解完整要求,然后通过技术参考文档配置您的应用 manifest 和权限。