某些应用程序和集成需要特殊权限才能联通或更改你的商店。这些权限以API帐户(也称为OAuth令牌或密钥)的形式提供,可以直接从您的控制面板创建。

App Marketplace中提供的大多数应用程序都是单击式应用程序,它们不需要创建专用 API 帐户,然后将这些凭据提供给第三方的附加步骤。

创建API帐户

要创建API帐户,您必须以店主身份登录店铺网页。

1. 进入设置API 帐户,然后单击+创建API帐户

每个商店最多可以创建50个帐户。

2. 选择账户类型。这将决定新帐户是用于主题定制的V2/V3 API令牌还是Stencil-CLI令牌。对于stencil-CLI令牌,您可以选择访问级别。相关更多信息,请参阅开发中心中的实时预览主题

3. 输入与此帐户对应的应用程序/集成的名称,然后复制或记下API路径 — 您需要它才能使用API帐户。名称至少可以包含四个字符。

4.OAuth Scopes下,指定您的应用程序/集成需要访问的API资源和权限。

我们提供了多种OAuth范围,用于自定义和控制对您商店数据的访问。有关更多信息,请参阅我们的API文档

5. 完成更改后,单击保存。成功保存将显示如下所示的弹出窗口。它包含了您的应用进行OAuth访问所需的API凭据,并且您的浏览器将提示您下载包含相同凭据的.txt文件,以便在您的计算机上安全保存。

 

保留您的凭据!选择完成以将其关闭后,无法返回此弹出窗口。确保存储您的凭据—通过复制/粘贴弹出窗口中每个字段的内容或保留下载的.txt文件。我们建议将步骤2中的API路径值添加到这些凭证中,因为它用于使用令牌的所有API调用。

删除API账户

要删除Store API帐户,请单击 按钮,然后从菜单中选择删除。

查看Webhook

Webhook是一种通过用户活动触发的自定义回调来更改网页或应用程序行为的方法。创建API帐户后,您将能够查看商店中哪些webhook处于活动或不活动状态,哪些webhook当前被列入黑名单,以及哪些域与商店相关联。

要查看与API帐户关联的webhook,请单击 按钮,然后从菜单中选择Edit。

您将看到一个webhook事件列表,以及每个事件的目标URL、创建日期和状态。

通知设置

您可以设置在发生一个或多个事件时发送的通知电子邮件,帮助管理webhook事件。无论是在禁用Webhook或将域列入黑名单时,你都能收到通知,从而在出现任何问题时快速响应。

您可以输入多个电子邮件地址,多个用逗号分隔。设置好后,单击保存

常问问题

作为应用程序开发人员,有哪些身份验证选项?

任何打算在BigCommerce应用市场上销售的应用都必须使用OAuth。OAuth与所有当前和计划中的BigCommerce API兼容,包括v2 Webhooks和我们的v3 API。有关更多信息,请参阅我们在开发中心的身份验证文档

我可以在试用商店中创建API帐户吗?

可以,店主可以在试用商店中创建API帐户。

如何启用旧API帐户以使用需要它的应用程序?

无法再在控制面板中创建旧版API帐户。我们建议联系应用提供商更新他们的集成以使用商店API帐户。

如果API帐户被删除,我还能修改与其关联的webhook吗?

不能。任何关联的webhook将在48小时后自动停用,服务器停止响应并显示状态码为200。

如何判断特定OAuth范围处理了哪些API权限?

以下是所有可用OAuth范围的列表以及每个范围权限的摘要。请记住,某些范围受到限制,例如日志存储为只读。