Stripe Apps 集成指南
Stripe Apps 让你把自定义功能直接嵌入 Stripe Dashboard。本章是一份构建指南:它记录了面向 Tajo–Brevo 集成的这样一个 app 会如何构建、测试和发布。
Caution
状态:尚未发布。 目前 Stripe App Marketplace 上还没有 Tajo 的 app,这些页面中的 app 标识、URL 和凭据都是用于示意的占位值,而不是可用的线上端点。如果你现在就要把 Stripe 连接到 Tajo,请使用 Stripe 连接器(受限 API key,只读同步)。
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 连接起来,实现:
- 客户洞察:把 Stripe 客户档案、支付历史和终身价值同步到 Brevo 联系人
- 事件跟踪:把 Stripe 事件(支付、订阅、退款)作为 Brevo 事务性事件推送
- 自动化营销活动:基于 Stripe 上的活动触发 Brevo 的邮件、短信和 WhatsApp 营销活动
- 忠诚度计划:用同步到 Brevo 的 Stripe 购买数据搭建留存工作流
架构概览
指南内容
本文档覆盖构建并发布一个 Stripe App 的完整生命周期:
快速上手
| 指南 | 说明 |
|---|---|
| 发布到 Marketplace | 提交 app 送审的要求与步骤 |
| App 审核要求 | 获得批准所需的质量、安全和 UX 标准 |
配置与参考
| 指南 | 说明 |
|---|---|
| App Manifest 参考 | stripe-app.json manifest 文件的完整 schema |
| Permissions 参考 | Stripe API 权限的完整清单,以及申请方式 |
| Viewports 参考 | app 界面可以出现的 Dashboard 位置 |
功能与集成
| 指南 | 说明 |
|---|---|
| 嵌入式 Stripe Apps | 在平台集成中使用 Connect 嵌入式组件 |
| 安装链接与深度链接 | 生成安装 URL,并深度链接到 app 的特定视图 |
| 安装后操作 | 配置 app 安装完成后的引导流程 |
运营与增长
| 指南 | 说明 |
|---|---|
| App 数据分析 | 跟踪安装量、浏览量和转化指标 |
| 合作伙伴生态 | 借助 Stripe 的合作伙伴计划做联合营销与增长 |
前置条件
在开始构建 Stripe App 之前,请确认你已具备:
- Stripe 账号:已激活的 Stripe 账号(不能仅限于测试模式)
- Stripe CLI:安装 Stripe CLI,用于本地开发和上传 app
- Node.js:版本 16 或更高,用于 app 的 UI extension
- Tajo 平台访问权限:有效的 Tajo 账号,且已配置 Brevo API 凭据
快速开始
# 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 start核心概念
App Manifest
每个 Stripe App 都有一个 stripe-app.json manifest,用来声明权限、viewport 和配置。完整 schema 见 App Manifest 参考。
UI Extensions
Stripe Apps 可以在特定的 Dashboard viewport 中渲染基于 React 的 UI 组件。UI 工具包提供与 Stripe Dashboard 设计系统一致的预置组件。
Permissions
App 必须声明它需要访问的具体 Stripe API 资源。用户会在安装过程中批准这些权限。见 Permissions 参考。
签名密钥
每个 app 都会拿到一个 signing secret,用于校验安装签名,并保护你的后端与 Stripe 之间的通信。
开发流程
- 定义 manifest,写明所需的权限和 viewport
- 构建 UI extension,使用 Stripe 的 React 组件库
- 实现 后端端点,通过 Tajo 与 Brevo 同步数据
- 测试,在本地使用
stripe apps start - 上传,使用
stripe apps upload - 提交 审核,通过 Stripe Dashboard 完成
- 发布,并通过数据分析持续观察
Caution
Stripe 要求上架 marketplace 的 app 必须使用英文撰写。你的 app 上架信息、UI 文案和文档都必须是英文。
后续步骤
先从发布指南开始,弄清全部要求,然后逐一阅读技术参考,配置你的 app manifest 和权限。