跳到主要内容

创建应用

前置需求​

你已阅读应用类型，并确定要构建公有应用。

创建应用​

Shoplazza 要求公有应用在使用 Shoplazza Open API 资源之前，必须完成 OAuth 2.0 授权。因此，在应用开发阶段，您需要先创建一个公有应用。

  1. 登录您的合作伙伴账号并进入合作伙伴后台。在左侧面板中选择"应用"，然后点击"创建应用"按钮。

  1. 输入应用名称，然后点击"创建"。
备注

应用名称是应用实体的代表，是系统在后端处理逻辑中使用的唯一标识符。该名称通常不会显示在应用市场或店铺应用安装列表中。

  1. 应用创建后，您的 Client ID 和 Client Secret 将自动生成，可在应用设置页面查看。

应用配置​

在开发店铺测试应用之前，您需要在应用配置中添加 Redirect URL，以便运行验证来解锁测试功能。

  1. 要添加 Redirect URL，请点击应用配置下方的"配置"。

  1. 在此处您可以添加 App URL 和 Redirect URL。

  • App URL（应用入口）：商家安装或打开应用时最先访问的地址，也是 OAuth 授权的起点。Shoplazza 请求这个地址时会带上 shop、store_id、hmac 等参数。后端校验 hmac 后判断该店铺是否已授权：未授权就重定向到授权页，已授权就直接进入应用。例如 https://your-app.example.com/auth。

  • Redirect URL（授权回调）：商家在授权页确认授权后，Shoplazza 带着授权码 code（以及 state、hmac）跳回的地址。后端校验后用 code 换取 access_token，安装即完成。例如 https://your-app.example.com/auth/callback。完整流程见 OAuth 鉴权。

注意
  • App URL 和 Redirect URL 都必须使用 HTTPS。
  • Redirect URL 必须与代码中授权请求携带的 redirect_uri 完全一致，包括路径和末尾的斜杠，否则授权会失败。

  • 嵌入选项：开启后，应用页面在 Shoplazza 后台框架（iframe）内打开；关闭则作为独立网站打开。两种方式的区别见应用类型。

  • 事件订阅：事件可以理解为一种"通知"。订阅事件后，当某类业务状态发生变化（如订单创建、商品更新）时，Shoplazza 会通过 webhook 把消息推送给您的应用，以便及时处理。事件版本决定推送内容按哪个 API 版本序列化。各事件的含义和最低版本见支持的 Webhook 事件。

  • 支持的国家/地区：哪些国家/地区的商家可以看到该应用，默认为 Worldwide（全球）。

管理上架信息​

应用上架信息将在应用市场中展示，商家可通过该信息了解应用功能并进行安装。上架信息支持多语言，目前仅支持英文和中文。

  1. 在应用设置页面，进入"应用上架信息">"管理上架信息"。

  1. 点击"开始上架"以添加所需信息。

  1. 在上架信息页面，您可以添加应用基本信息、上架内容、定价详情以及支持与资源。

  • 应用上架名称：应用在应用市场中展示的名称，商家可见并使用，支持多语言。相比之下，应用名称供开发者管理应用使用，是应用在系统内信息传递的唯一标识符。

  • 上架内容：对您应用的全面介绍，在应用市场中供商家查阅。详细描述中可嵌入 HTML 代码以提升视觉效果。可使用"预览"功能查看应用在市场中的展示效果。

  • 定价详情：选择一种计费模式。

定价配置指南​

每个应用只能选择一种计费模式，首次审核通过后不能再更改。请按应用实际的收费方式选择：

计费模式商家如何付费
免费不收取任何费用。
免费安装安装免费，使用过程中按用量另外收费（如每 100 封邮件 1 美元）。
计费周期可自定义。
周期性收费按周期收取订阅费，可设置多个套餐，也可以在订阅费之外再按用量收费。
一次性付款商家只需付款一次，之后使用不再收费。

各模式的接入方式见集成应用收款。

1. 免费模式​

2. 免费安装模式​

3. 周期性收费模式​

  • 仅订阅

  • 订阅 + 使用量

4. 一次性付款模式​

下一步​

配置好应用的 Client ID、Client Secret 和 Redirect URL 后，继续阅读开发独立应用来搭建项目并实现 OAuth。

在此页面