管理api
构建应用程序
快速启动
指南
教程
建立渠道
快速启动
指南
教程
建筑店面
管理货币
指南
合作伙伴信息
成为合作伙伴
开始
POS解决方案
ERP解决方案
PIM解决方案
OMS的解决方案
营销解决方案
运输解决方案
支付解决方案

脚本API

BigCommerce脚本API为开发人员提供了以编程方式将脚本注入商店模板文件的能力。这种能力意味着应用程序和集成程序可以将脚本插入用户的店面,而不需要用户手动将代码片段粘贴到控制面板中。你可以使用这个API插入很多类型的脚本,包括下面的:

  • 分析脚本
  • 单击应用程序脚本
  • 实时聊天和支持插件
  • 主题扩展或连接器应用程序

脚本管理器API合作伙伴指南

有了脚本管理器API,你的应用程序现在可以将脚本插入用户的店面,而不需要用户手动将代码片段粘贴到控制面板。在安装你的应用程序后,你可以免费更新这些脚本,如果需要,如果你卸载你的应用程序自动删除脚本。

在我们最新的主题(模板)上安装应用程序的过程相对简单。然而,如果你的应用已经上线,你可能已经要求商家将代码片段粘贴到控制面板的以下两个部分之一:

  • 页脚的脚本
  • 网络分析

另外,由于我们的旧主题(基于蓝图的)不支持脚本管理器API,您仍然需要某种方式来为旧主题的用户提供他们需要的文档,而不需要为新主题的用户提供额外的、不必要的步骤。

为了帮助您转换到脚本管理器API,我们提供了一些建议策略来处理这些不同的情况。

模板和蓝图

如上所述,BigCommerce支持两个主题引擎:Stencil和Blueprint。钢网是我们最新的技术,所有新的商店只有访问钢网主题。然而,旧的商店使用我们的遗留主题引擎Blueprint,它不能呈现通过脚本管理器API插入的脚本。

因此,您需要检查用户是否正在运行Stencil,以确定他们的存储是否支持脚本管理器API。要做到这一点,使用获取存储信息API端点并检查stencil_enabled国旗。(需要store_v2_information_read_only范围)。

先决条件

本文包含关于脚本API的详细信息,并假设您熟悉BigCommerce应用程序的安装过程。有关应用程序安装过程的更多信息,请参见应用程序安装

升级和安装

在模板上安装应用程序

我们建议在模板存储上安装的应用程序的认证回调流程中,在收到POST响应后立即插入脚本。使用脚本管理器API的Create Script端点添加脚本。

我们强烈建议离开auto_uninstall标志设置为true,这样你的应用程序将在卸载时正确地清理自己。找到更多关于这个标志的信息在这里

升级模板上现有的应用程序

如果你已经发布了你的应用,你可能已经有用户在他们的控制面板上粘贴了代码。有几个可能的方法来处理这种情况。

什么都不做

如果您不需要将现有的商家升级到脚本管理器API,那么完全可以离开它们。您需要维护手动卸载过程的文档,以便使用较旧安装的商家知道需要清理哪些内容。您将无法为这些用户自动更新或添加脚本。

提示商户升级

如果你想让你的商家随着时间的推移更新到新的脚本管理器,你可以在你的应用程序的登录页面上提示他们这么做。您需要跟踪哪些商户没有使用脚本管理器,以了解是否需要显示此提示。在提示它们升级之前,确保它们正在运行Stencil(通过Get Store Information端点)。

一旦用户决定升级,您可以引导他们在控制面板中删除旧的粘贴代码,然后,一旦商家单击一个按钮,通过脚本管理器API安装您的脚本。

静默升级到脚本管理器API

最后,假设旧的粘贴脚本可以与新的脚本管理器API脚本共存。在这种情况下,您可以升级到使用脚本管理器API,而不需要任何用户干预。这是否可行取决于你的应用程序的实现。

当你的商家在他们的店面页面上加载的数据比需要的要多的时候,这个方法将允许你在所有的安装中立即使用脚本管理器API。请记住,您仍然需要记录现有安装的手动卸载过程。

在Blueprint商店安装应用程序

如上所述,Blueprint主题引擎不支持脚本管理器API。您将无法在任何店面首页上呈现通过此API插入的任何脚本。为了防止不可预知的行为,如果用户改变了他们的主题,我们强烈建议在通过脚本管理器API安装任何脚本之前检查Get Store Information端点对模板的支持。此外,当存储区不支持模板时,您仍然希望显示旧的手动安装步骤。

现有的图纸安装

现有的blueprint安装不会受到影响,但是请记住,如果提示现有的Stencil用户升级到脚本管理器,您将不希望为blueprint用户显示此消息。

固定失踪的脚本

你的应用程序安装可能会发现自己意外地缺少一个或多个脚本。以下是一些可能导致此问题的原因。

1)。商人删除了你的脚本

当商家试图删除属于某个应用程序的脚本时,会收到警告,但我们允许他们这样做。

为了优雅地处理这种情况,我们建议您检查得到的脚本端点在你的应用程序细节页面(返回负载调URI以确定是否存在预期的脚本。如果不是,您可以提示用户单击一个按钮来自动修复安装。

我们要求您请求用户的许可,而不是自动删除,因为他们可能有很好的理由删除丢失的脚本。

2)。商人的主题设置不正确

主题模板必须有把手表达式{{head。脚本}}和{{页脚。脚本s}} in the pages to render scripts. If either of these is absent, scripts on that page with location set to head or footer (respectively) will not render correctly.

特别值得注意的是,{{head。脚本s}} was only recently added to the checkout and order confirmation pages in our Cornerstone theme, and widespread adoption of this standard outside of Cornerstone is still an ongoing process.

为了确保你的应用程序与尽可能多的主题兼容,我们建议在签出、order_confirmation和all_pages可见性方面增加页脚开销。

3)。脚本不会在签出和订单确认中呈现

为了呈现脚本,商店必须启用BigCommerce优化的单页结帐功能。这是所有新模板存储的默认签出类型。现有商店必须手动更改本文中详细介绍的签出类型。

来自市场的模板主题支持优化单页结帐。然而,在某些情况下,商家维护他们的私有主题,却不能支持优化的单页签出。在这种情况下,商家必须按照下面的步骤添加主题支持在这里

笔记

  • 如果您在签出中注入脚本,您将需要更新签出内容的范围。的店主只能创建帐户。
  • 商家可以在控制面板中看到商店安装的脚本。在本机标签管理器中,商人操作仅限于查看和删除脚本。
  • 脚本可以位于头部{{head.scripts}}和页脚{{footer.scripts}}
  • 脚本管理器仅用于模板主题。蓝图存储用户仍然需要在代码中复制和粘贴。
  • 当前的可见性选项是店面,结帐,all_pages,order_confirmation
  • 当你通过模板CLI本地开发主题时,通过脚本API注入的脚本将不会呈现。
  • 每个应用程序可以有10个脚本。
  • 在一个调用中最多可以安装5个脚本。
<!--全球网站标签(gtagjs)-谷歌分析--><脚本异步src=“https://www.a-esupply.com/gtag/js?id=GA_TRACKING_ID”></脚本><脚本>窗口dataLayer=窗口dataLayer||(];函数gtag(){dataLayer(参数);}gtag(js的,日期());gtag(“配置”,“GA_TRACKING_ID”);</脚本>

脚本能见度的位置

范围 可见性
all_pages 添加列表
博客列表
博客
品牌页面
所有品牌的页面

类别
结帐
我的账户
产品比较
订单确认
页面
付款方法
登录
触点形式
产品
搜索
所有的清单
愿望清单
404页的
店面 添加列表
博客列表
博客
品牌页面
所有品牌的页面

类别
产品比较
页面
触点形式
我的账户
产品
搜索
所有的清单
登录
愿望清单
404页的
结帐 结帐
order_confirmation 订单确认

脚本不能注入到:

  • giftcertificates.php
  • sitemap.php

相关资源伟德棋牌大全

端点