概述

通过将应用程序与 Online Store 集成,你可以向数百万商家的客户展示你的应用程序的功能。 SHOPLINE 为应用程序开发者提供了一个灵活的平台,允许合作伙伴使用 Handlebars 模板引擎,在 SHOPLINE CDN 上托管资产,并使用版本控制进行流水线部署。灵活的应用集成主题机制允许商家为其客户提供定制的购物体验。
本指南介绍了如何将应用程序与 Online Store 集成的方法。


应用程序与主题集成的三种方式

针对 SHOPLINE Online Store 的不同版本的主题,下表重点展示了推荐你使用哪种方式集成:

Online Store 版本应用类型主题应用扩展(App Blocks)主题应用扩展(App Embed Blocks)Script TagAsset API
Online Store 2.1公共应用推荐推荐不推荐不推荐
自定义应用不支持不支持不推荐不推荐
私有应用不支持不支持不推荐不推荐
Online Store 2.0公共应用推荐推荐不推荐不推荐
自定义应用不支持不支持不推荐不推荐
私有应用不支持不支持不推荐不推荐
Online Store 1.0公共应用部分支持(见注意)推荐不推荐不推荐
自定义应用不支持不支持推荐推荐
私有应用不支持不支持推荐推荐
注意

Online Store 1.0 的主题只有首页才支持添加主题应用扩展(App Blocks),其他页面暂时不支持。

针对 Online Store 1.0 版本的主题,Script TagAsset API 都可以集成到主题,但它们之间还是会存在一些区别:

  1. Script Tag 不会对主题私有化,而 Asset API 会对主题私有化
  2. 应用场景不同,Script Tag 会在店铺页面运行时注入 JavaScript 脚本,具体可以参考 Script Tag。而 Asset API 可以操作店铺的主题资源,关于主题资源可以参考主题架构

主题应用程序扩展

主题应用程序扩展为你的应用程序提供了两种扩展在线商店主题的集成类型:App BlockApp Embed Block。你提交到 SHOPLINE 应用商店的每个新应用都需要使用主题应用扩展来与在线商店主题集成。
主题应用程序扩展不编辑主题代码,它有以下好处:

  • 使用主题应用程序扩展不会造成主题私有化,私有主题享受不到官方主题更新带来的好处,这会降低应用程序对主题进行重大更改的风险
  • 最小化应用程序入侵主题带来的技术债务
  • 给商家带来简单易用的应用集成方式和定制灵活性,提高应用使用率
  • 由于即插即用的集成方式,提高用户的留存率
提示

Online Store 2.0 及其以上主题都支持主题应用扩展

Script Tag

如果你的应用程序添加了与 Online Store 1.0 主题 不兼容的 App Block,那么你可以使用 Script Tag REST Admin API 的方式兼容 Online Store 1.0 主题。如果你要向 SHOPLINE 应用商店提交新应用,那么你应该要为 Online Store 2.0 及以上版本的主题提供 App Block。

Script Tag 代表在远程服务器上运行的一些 JavaScript 代码。你可以使用该 Script Tag 在 section 的页面被访问时,加载远程的 JavaScript 到主题的 section 中。Script Tag 资源归属创建它们的应用程序,当应用程序删除时,它创建的所有 Script Tag 也会被删除。另外,Script Tag 无法使用 Handlebars 能力来修改主题模板代码。

你可以使用 Script Tag 添加页面功能,而无需手动修改主题模板代码,它有如下的好处:

  • 无需手动编辑主题模板即可向商店页面添加功能。
  • 商家卸载应用程序后,主题模板会恢复到安装应用程序前的状态。

Asset API

如果你的应用必须编辑 Online Store 1.0 主题代码,你可以在应用内使用主题的 Asset API 将应用集成到主题中。

Asset API 是指与在线商店主题相关的 API 资源,你可以通过 Asset REST Admin API 来读取、添加、更改或删除主题相关的资源文件及内容。使用 Asset API 集成的方式会导致主题私有化,这也意味着私有化的主题将享受不到官方主题版本升级带来的更新。因此,更加推荐下面的做法:

  • 提供有关这些主题资源的更新代码和详细规范
  • 注意已经集成了应用的主题是否有新版本。参考 Online Store 2.1 主题 获得有关主题版本的信息。当你使用的主题更新时,请确保你的应用程序与新版本兼容。

有关如何使用 Asset API 的详细信息,请参阅 Asset API

构建在线商店应用程序的注意事项

如果你的应用程序与商店的主题存在交互,那么你需要确保该应用程序也可以在主题编辑器环境中运行。如有必要,你可以在应用程序代码中检测是否在编辑器中,以便你可以调整应用程序以在该环境中工作。

更多参考

这篇文章对你有帮助吗?