公共应用配置说明
当你已经了解一个 SHOPLINE 应用的分发方式,并希望构建一个公共应用在应用市场分发时,你需要阅读这篇文档。这篇文档将会详细介绍如何在开发者中心创建一个新的应用。
你将学到什么
- 公共应用的详细配置方法
在此之前你可能需要了解
- SHOPLINE 应用的分发方式
- 创建应用的流程
STEP 1 创建应用
- 进入开发者中心“应用”模块,点击“创建应用”按钮
- 选择“公共应用”并填写基本信息
- 应用名称:仅用于开发者管理,应用市场的展示名称看“应用详情”中配置。
- 应用地址:应用的运行地址,商家在平台进入应用时,SHOPLINE 回跳转到这个地址。
- 应用回调地址:用于接收平台的回调,比如请求授权时,SHOPLINE 会携带参数回调到这个地址。
- 当你需要在不同的应用环境接收回调进行测试时,你可以配置多个回调地址。
- 配置多个回调地址的情况下,需要在请求参数中指定接收回调地址。
STEP 2 完成基础配置
- 点击创建好的应用,进入应用配置面板;选择“应用设置”
-
应用打开方式:
- 内嵌:以 iframe 加载方式在商店管理后台打开,商家不需要跳离 SHOPLINE 管理后台,具备更优秀的使用体验。选择内嵌方式,需要接入平台提供的 App Bridge 能力。
- 外跳:在浏览器打开新标签页运行应用。
-
嵌入 SHOPLINE POS:如果你的应用支持在 SHOPLINE POS 加载使用,请开启这一选项。
- 应用联系人:SHOPLINE 在发布重大消息时,将会通过该联系方式与你联系,请保证联系人信息准确并有效。
- GDPR 必需的 webhook:这是强制订阅的 webhook ,为满足各国家政府对个人数据的保护政策,开发者需要提供有效回调地址并监听消息。
STEP 3 完成应用详情配置
- 进入应用详情配置,在这里你可以
- 管理你的应用在应用市场详情页的信息展示:你可以配置多个语言的应用信息,确保更有效地向商家介绍你的应用。
- 设置在应用市场的可见性:管理应用是否要在应用市场被商家发现,比如当你的应用存在问题,希望暂时不要引入新的商家时,你可以使用这个功能。
- 更换你的默认语言:当商家使用的语言不在你已经配置的语料范围内时,我们会使用默认语言进行展示
Tip
建议将默认语言设置为英语
,这样能满足大多数商家的阅读
- 应用详情信息配置
- 应用名称:这个名称会显示在应用市场,取一个符合应用调性的名称,更容易让那个商家记住你。
- 应用描述:简单描述这个应用能够为商家带来的价值,会吸引到更多商家的关注。
- 应用logo:这是商家对应用的第一印象,上传一个120*120的高品质logo吧。
- 产品特色说明:你可以提炼出三个特色说明突出应用的优势。
- 应用联系人会展示在应用市场的详情页,可以帮助你收集商家的建议,及时处理商家问题,提高你的用户使用体验。
STEP 4 提交审核
理论上完成以上基本信息的填写,你就可以提交上线审核。但上线前建议你对应用进行必要的测试,确保应用为商家提供的服务是有效且合理的。如果你没有正式的商店,可以借助平台提供的开发商店进行测试。
STEP 5 订阅 Webhook 事件(可选)
事件订阅并不是必须的,但是合理利用订阅事件可以让你的应用数据跟 SHOPLINE 保持同步。商店发生特定事件的之后,平台会触发 Webhook 通知,将消息发送给被店铺安装且订阅了该事件的应用。 你可以在开发者中心管理你订阅的内容:
- 事件:选择需要订阅的事件名称
- 通知URL:当店铺触发这个事件时,平台会将消息发送到填写的这个地址
- 事件版本:平台会固定每个季度更新一个API 版本,参见:API 版本管理说明,当订阅的事件版本下线时,平台会按照当前最旧的一个版本内容进行返回。
后续动作
除了应用审核必要的信息,你还可以在开发者中心管理更多的内容,你可以通过以下文档查看
这篇文章对你有帮助吗?