管理api
目录
顾客
电子邮件模板
新的
订单
订单退款
交付过程
价格清单
价格订单
参考
脚本
设置
航运
小部件
Webhooks.
构建应用程序
快速开始
指南
教程
建筑渠道
快速开始
指南
教程
新的
建筑店面
管理货币
指南
合作伙伴信息
成为合伙人
开始
POS解决方案
ERP解决方案
PIM解决方案
OMS解决方案
营销解决方案
运输解决方案
支付解决方案

关于我们的api

想马上开始做API请求吗?检查快速开始

BigCommerce的api集允许您创建应用程序,自动存储流程,或构建无头电子商务解决方案。需要灵感来建造什么?访问我们的应用市场

可用的api

BigCommerce有几个不同的API,可让您管理商店数据,对客户进行身份验证,使客户端查询进行产品信息等。

REST API(V2&V3)

BigCommerce的REST api(例如目录的API)允许您管理存储数据并采取模拟存储管理员活动的操作。REST API的一些示例使用是:

  • 在商店添加和更新产品
  • 更新客户的订单并更改订单状态
  • 创建优惠券
  • 管理客户的商店帐户详细信息

店面API.

店面API.允许您管理客户购物车和结帐并订购信息客户端。店面API的一些示例使用是:

  • 使用Javascript将商品添加到商店前面的购物者购物车中
  • 以编程方式检索和向客户提供有关其最近订单的信息
  • 更新结帐的账单地址
  • 清除客户当前购物车

GraphQL API.

BigCommerce的GraphQL API.允许您查询产品和客户数据并远程存储设置或从商店的前端存储设置。一些用例示例是:

  • 用Javascript将产品数据拉入模具主题
  • 通过站点的前端访问客户数据
  • 从商店前端获取类别和品牌的详细信息

客户登录API

客户登录API让您以编程方式登录客户到BigCommerce StoreFront。此API的一些示例使用是:

  • 客户通过第三方系统登录BigCommerce商店
  • 使用除电子邮件和密码以外的凭据启用登录(即,使用电话号码)
  • 将BigCommerce商店与SSO提供者集成

当前客户API.

BigCommerce的当前客户API.允许您在会话期间确定哪些客户登录到店面。

  • 在浏览器中确认客户的身份
  • 验证客户的身份,以从外部应用程序显示特定信息

API环境

在店面或服务器到服务器的上下文中发出BigCommerce API请求。

API. 基URL
服务器到服务器 https://api.bigcommerce.com/stores/ {store_hash} / v3 /
V2 https://api.bigcommerce.com/stores/ {store_hash} / v2 /
店面API. https://your-store.mybigcommerce.com/api/以上点}
GraphQL https:// www。{bigcommerce_storefront_domain} .com / graphql
客户登录 https://www。{bigcommerce_storefront_domain} .com/login/token/{牌}
当前客户 /客户/ current.jwt吗?app_client_id = {app_client_id}

可用的存储资源伟德棋牌大全

资源 描述
目录 目录API管理商店的产品,品牌和类别。
商店信息 获取系统时间戳和基本商店信息。
货币 管理店面上显示的货币。
地理 获取一份州和国家的列表。
税收课程 在商店获得可用的税务课程。
店面推车 创建一个cart或从前端抓取cart数据。
店面结帐 创建签出或从前端提取签出数据。
服务器到服务器的车 创建购物车并绕过BigCommerce前端。
服务器到服务器结帐 创建结账并绕过BigCommerce前端。
订单 创建和管理订单。
订购交易 查看订单付款信息。
店面订单 查看店面订单信息。
顾客 管理存储的客户。
V3客户 管理存储的客户。要了解如何使用V3客户vs V2客户,请参见客户概述
订阅者 管理通讯用户。
(价格清单)(/ api参考/目录/ pricelists-api 创建目录定价的变体。
脚本 将脚本添加到存储页面。
营销 创建和管理优惠券、横幅和礼品券。
启用支付方法 获取商店上的可用付款方式列表。
处理付款 处理订单或结账时的付款。有两个API用于处理付款。得到支付访问令牌然后处理付款
航运 创建和管理运输方法和区域。
储物 管理商店的博客、网页和重定向。
店面GraphQL API 从模板主题或远程站点内查询店面数据。
主题 管理商店的主题。
小部件 以编程方式将内容注入BigCommerce主题。
愿望清单 Wishlist API允许开发人员创建和管理客户愿望列表。

REST API (V2 & V3)

请求标题

服务器到服务器的请求头至少需要Accept、X-Auth-Token和Content-Type。

允许的值 描述 例子
接受 应用/ JSON.(对于.json请求)应用程序/ XML(. xml请求) 用于接收响应的MIME类型格式。 应用程序/ XML
内容类型 应用/ JSON.(对于JSON请求)应用程序/ XML(对于XML请求) 请求体的MIME类型。用于验证和解析到API的请求。 应用/ JSON.
用户代理 字符串 虽然这不是必须的,但我们要求您指定一个用户代理来标识您的集成/客户端与您的请求。
X-Auth-Token 字符串 访问令牌授权应用程序代表用户访问资源。伟德棋牌大全

响应头

可能的价值 描述 例子
日期 一个RFC 2822日期。 响应已发送的日期。 星期二,2011年11月15日12:45:26 GMT
last - modified 一个RFC 2822日期。 资源上次修改的日期。请参阅各个资源页面以支持此标题。 星期二,2011年11月15日12:45:26 GMT
内容类型 应用/ JSON. 响应的MIME类型,取决于所请求的端点的扩展。 应用/ JSON.
内容位置 Uri. 如果已重定向请求,则发送。 /api/v2/orders/5.json.
位置 Uri. 新创建资源的URI。发送的201创建了回复。 / API / V2 /产品/ 7
X-Retry-After 整数 率有限响应,表示配额刷新前的秒数。看速率限制想要查询更多的信息。 15
X-BC-ApiLimit剩余 整数 当前期间剩余的API请求数量(滚动一小时)。看速率限制想要查询更多的信息。 987
X-BC-Store版本 版本号 商店正在运行的BigCommerce的版本。此标题可在版本7.3.6+上提供。 7.3.6
内容编码 GZIP. 允许API客户端在响应API请求之前请求压缩内容。 GZIP.
传输编码 分块 指定用于传输资源的编码形式。 分块
X-Rate-Limit-Requests-Left 数字 详细说明当前窗口中您的客户端在限速之前还可以发出多少剩余请求。在这种情况下,您希望能够在接下来的3000毫秒内再发出6个请求;在3000毫秒内的第7个请求中,您将受到速率限制,并将收到一个HTTP 429响应。 16101491
X率限制 - 请求 - 配额 数字 显示您的客户端的当前窗口中允许多少API请求。 16101495
X-Rate-Limit-Time-Reset-Ms 数字 显示窗口中剩下多少毫秒。在这种情况下,3000毫秒 - 因此,在此请求后3000毫秒,API配额将被刷新。 30000
X速率限制 - 时间窗口-S 数字 显示当前速率限制窗口的大小。 9762

媒体类型

媒体类型是请求或响应主体的格式。BigCommerce API接受请求并在JSON中响应。您应该使用UTF-8字符集进行编码请求(其他字符集可能具有不可预测的结果)。

内容类型

请求内容类型

执行包含正文(例如Post或Put)的请求时,需要在Content-Type标题中指定要发送的内容类型。

响应内容类型

有两种方法可以指定您想要接收的内容类型。第一个方法是指定一个Accept报头。第二种方法是向所请求的资源提供扩展。

您可以处理这些方法的优先级是:

  • 接受报头的高优先级类型(例如。接受:应用/ JSON)资源上的扩展(例如客户.JSON.)。
  • 接受报头的低优先级类型(优先级小于1,例如:接受:应用/ JSON; Q = 0.9)

请求结构

JSON请求的主体是一个包含一组键值对的对象。product对象的一个简单表示是:

{“ID”:5,“名称”:“iPod”,“描述”:“一个便携式MP3音乐播放器。”}

响应结构

响应的结构与请求类似。如果请求返回单个对象,则响应将包含单个对象,该对象包含该资源的字段。

得到一个类别/ get https://api.bigcommerce.com/stores/ {store_hash }/v3/catalog/categories/ {category_id}

{“数据”:{“ID”:39,“parent_id”:19,“名称”:“浴”,“描述”:”“,“观点”:0,“排序”:0,“页面标题”:”“,“meta_keywords”:(”“],“meta_description”:”“,“layout_file”:“category.html”,“image_url”:”“,“is_visible”:真的,“search_keywords”:”“,“default_product_sort”:“use_store_settings”,“custom_url”:{“URL”:“/花园/洗澡/”,“is_customized”:}},“meta”:{}}

支持

开发者社区

开发人员社区是从其他开发人员获得帮助的好地方,他们在大型商品平台上工作。如果您有特定于大型的问题,这个在线论坛是最好的要求。这也是初学者获得帮助的优秀场所。

StackOverflow

您是一个更经验丰富的开发人员还是具有编程语言特定的问题?这个在线论坛是提出问题并获得帮助的好地方。开发人员社区是专门了解BigCommerce平台的最佳位置。

伟德棋牌大全