发布到 Stripe App Marketplace
将 Stripe App 发布到 marketplace 后,所有 Stripe 用户都可以使用它。本指南涵盖了要求、准备步骤和提交流程。
前提条件
在将应用发布到 Stripe App Marketplace 之前,您必须满足以下要求:
- 已激活的 Stripe 账户:您的账户不能仅限于测试模式
- 每个账户一个应用:每个 Stripe 账户只能向 marketplace 发布一个公开应用
- 仅英文:所有应用内容、UI 文本和 listing 信息必须使用英文
- 完整的应用:您的应用必须完全可用并经过测试
Caution
如果您需要发布多个应用,必须为每个应用创建单独的 Stripe 账户。
发布步骤
步骤 1:更新 Manifest
在 stripe-app.json 中将 distribution_type 设置为 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" } ]}步骤 2:准备应用
在提交之前,确保您的应用满足所有审核要求:
- 在 live 模式和 sandbox 模式下彻底测试
- 验证所有权限都是必要的并已记录
- 确认已实现错误处理和 loading 状态
- 检查所有 UI 文本都是英文
步骤 3:上传应用
使用 Stripe CLI 上传应用:
# 将应用上传到 Stripestripe apps upload
# 验证上传stripe apps versions list步骤 4:编写 Listing
导航到 Stripe Dashboard 完成您的应用 listing。Marketplace 提交需要所有 listing 字段。
步骤 5:提交审核
完成 listing 后,通过 Stripe Dashboard 提交应用进行审核。Stripe 团队将根据质量要求评估您的应用。
步骤 6:发布
获得批准后,您可以发布应用,使其在 marketplace 上可用。
公开分发的 Manifest 设置
Manifest 必须包含 distribution_type: "public" 并声明所有必需权限及清晰的目的说明:
{ "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" }}使用以下命令上传已配置的应用:
stripe apps uploadListing 要求
您的应用 listing 必须包含以下所有字段:
| 字段 | 要求 | 详情 |
|---|---|---|
| 名称 | 最多 35 个字符 | marketplace 上显示的名称 |
| 图标 | 300x300 像素,PNG 或 SVG | 方形图标,不要圆角(Stripe 会自动添加) |
| 构建者 | 公司或开发者名称 | 显示在应用名称下方 |
| 类别 | 从 Stripe 的类别中选择 | 选择最适合您应用的类别 |
| 副标题 | 最多 80 个字符 | 搜索结果中显示的简短 tagline |
| 关于 | 最多 1,000 个字符 | 应用功能的详细描述 |
| 主要功能 | 最多 5 个,带图片 | 用截图突出主要功能 |
| 价格 | 免费、付费或 freemium | 明确说明定价模式和费用 |
| 支持 | 联系 URL 或邮箱 | 用户可以获得帮助的地方 |
| 隐私政策 | 隐私政策 URL | 数据处理所需的法律文件 |
名称指南
- 在 marketplace 上必须唯一
- 应清晰标识应用的用途
- 避免可能让用户困惑的通用术语
- 示例:“Tajo for Brevo”(15 个字符)
图标指南
- 尺寸:精确为 300x300 像素
- 格式:PNG 或 SVG
- 不要添加圆角, Stripe 会自动应用
- 使用清晰、易识别的 logo 或符号
- 确保在小尺寸下清晰可见
关于部分
撰写引人入胜的描述,涵盖:
- 应用解决什么问题
- 主要集成能力
- 应用针对的用户群体
- 任何前提条件或要求
示例:
Tajo for Brevo 将您的 Stripe 支付数据与 Brevo 的营销自动化平台连接起来。自动同步客户、跟踪支付事件,并根据实时购买行为触发个性化的电子邮件、SMS 和 WhatsApp 营销活动。专为希望通过数据驱动的留存营销来最大化客户终身价值的电商企业而构建。
主要功能
每个主要功能条目包括:
- 标题:简短的功能名称
- 描述:一到两句话解释该功能
- 图片:截图或图表(建议 1600x900 像素)
Tajo Brevo 集成的推荐功能:
- 实时客户同步, 自动将 Stripe 客户档案同步到 Brevo 联系人,包含完整购买历史
- 事件驱动自动化, 从成功付款、订阅变更和退款等 Stripe 事件触发 Brevo 工作流
- 产品目录同步, 保持 Brevo 产品目录与 Stripe 同步,以实现个性化营销内容
- 多渠道营销活动, 使用同步数据推动有针对性的电子邮件、SMS 和 WhatsApp 营销活动
- Dashboard 洞察, 直接在 Stripe Dashboard 客户视图中查看 Brevo 参与度指标
测试应用
提交前,彻底测试您的应用:
在 Sandbox 模式下测试
# 以测试模式启动应用stripe apps start --mode test
# 验证 sandbox 兼容性stripe apps validate测试凭据格式
为审核团队提供测试凭据时,请使用以下格式:
Test Account Credentials========================Platform: TajoURL: https://app.tajo.io/testEmail: [email protected]Password: [secure test password]
Brevo Test API Key: xkeysib-test-xxxxxxxxxxxx
Required Setup Steps:1. Log in to the Tajo test account2. Navigate to Settings > Integrations > Brevo3. The Brevo API key is pre-configured4. 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审核清单
提交前验证:
- 应用在 live 和 test 模式下都能工作
- 所有权限都有清晰的目的说明
- 错误状态处理得当
- 异步操作显示 loading 状态
- 生产构建中没有硬编码的测试数据
- 隐私政策 URL 可访问且准确
- 支持联系信息有效
- 所有 listing 图片符合尺寸要求
- 应用描述准确反映功能
提交后
Stripe 审核团队通常在 5-10 个工作日内响应。他们可能:
- 批准您的应用发布
- 要求修改并提供具体反馈
- 拒绝不符合要求的应用
如果要求修改,请解决所有反馈并重新提交。每次重新提交都需要经历完整的审核周期。
更新已发布的应用
要更新已发布的应用:
- 在
stripe-app.json中递增版本号 - 上传新版本:
stripe apps upload - 提交更新进行审核
- 获批后,更新将自动部署给所有用户
Tip
小错误修复和非功能性更改可能获得快速审核。重大功能添加或权限变更需要完整审核。