关于我们的API.
想要立即开始制作API请求吗？看看快速开始。
BigCommerce集API允许您创建应用程序，自动化存储流程或构建无头电子商务解决方案。beplayti体育提现需要对建造什么的灵感？访问我们App Marketplace.。
可用API.
BigCommerce有几个不同的API，可让您管理商店数据，对客户进行身份验证，使客户端查询进行产品信息等。
REST API（V2＆V3）
BigCommerce的REST API（例如，目录API.）允许您管理存储数据并采取模拟存储管理员活动的操作。REST API的一些示例使用是：
- 在商店添加和更新产品
- 更新客户的订单并更改订单状态
- 创建一个优惠券
- 管理客户的商店帐户详细信息
店面API.
这店面API.允许您管理客户购物车和结帐并订购信息客户端。店面API的一些示例使用是：
- 将带有Javascript的项目添加到购物者的购物车从店面添加
- 以编程方式检索和向客户提供有关其最近订单的信息
- 更新结账的帐单邮寄地址
- 清除客户的当前购物车
GraphQL API.
bigcommerceGraphQL API.允许您查询产品和客户数据并远程存储设置或从商店的前端存储设置。一些用例示例是：
- 将产品的数据用JavaScript拉到模板主题中
- 通过站点的前端访问客户数据
- 从商店的前端获取类别和品牌详细信息
客户登录API.
这客户登录API.让您以编程方式登录客户到BigCommerce StoreFront。此API的一些示例使用是：
- 通过第三方系统登录客户到BigCommerce商店
- 使用除电子邮件和密码以外的凭据启用登录（即，使用电话号码）
- 使用SSO提供商集成BIGCommerce商店
当前客户API.
bigcommerce当前客户API.允许您在会话期间确定哪些客户登录到店面。
- 在浏览器中确认客户的身份
- 验证客户的身份，以从外部应用程序显示特定信息
API环境
在StoreFront或Server-to-Server的上下文中制作BigCommerce API请求。
| API | 基础网址 |
|---|---|
| 服务器到服务器 | https://api.bigcommerce.com/stores/{store_hash► |
| v2. | https://api.bigcommerce.com/store/{store_hash►/ 52/ |
| 店面API. | https://your-store.mybigcommerce.com/api/以上点} |
| GraphQL. | https://www。{bigcommerce_storefront_domain} .com/graphql |
| 客户登录 | https：// www。{bigcommerce_storefront_domain} .com / login / token / {token} |
| 当前的客户 | /customer/current.jwt?app_client_id= {app_client_id} |
可用商店资源
| 资源 | 描述 |
|---|---|
| 目录 | 目录API管理商店的产品，品牌和类别。 |
| 商店信息 | 获取系统时间戳和基本商店信息。 |
| 货币 | 管理店面显示的货币。 |
| 地理 | 获得国家和国家名单。 |
| 税收课程 | 在商店获得可用的税务课程。 |
| 店面推车 | 从前端创建购物车或刮推车数据。 |
| 店面结账 | 从前端创建结账或铲除结帐数据。 |
| 服务器到服务器购物车 | 创建购物车并绕过BigCommerce前端。 |
| 服务器到服务器结帐 | 创建结账并绕过BigCommerce前端。 |
| 命令 | 创建和管理订单。 |
| 订购交易 | 查看订单付款信息。 |
| 店面订单 | 查看店面订单信息。 |
| 顾客 | 管理商店客户。 |
| V3客户 | 管理商店客户。要了解使用V3客户VS V2客户，请参阅客户概述。 |
| 订阅者 | 管理时事通讯订阅者。 |
| [价格表]（/ API-Reference / Catalog / Pricelists-API | 创建目录定价的变体。 |
| 脚本 | 将脚本添加到存储页面。 |
| 营销 | 创建和管理优惠券，横幅和礼品券。 |
| 支持的付款方式 | 获取商店上的可用付款方式列表。 |
| 处理付款 | 处理订单或结账时的付款。有两个API用于处理付款。得到付款访问令牌然后处理付款。 |
| 船运 | 创建和管理送货方法和区域。 |
| 商店内容 | 管理商店的博客，网页和重定向。 |
| StoreFront GraphQL API. | 从模板主题或远程站点内查询店面数据。 |
| 主题 | 管理商店的主题。 |
| 小部件 | 以编程方式将内容注入BigCommerce主题。 |
| 愿望列表 | 愿望表API允许开发人员创建和管理客户愿望列表。 |
REST API（V2＆V3）
请求标题
服务器到服务器请求标题需要接受X-Auth-令牌和内容类型最小。
| 标题 | 允许值 | 描述 | 例子 |
|---|---|---|---|
接受 |
应用/ JSON.（对于.json请求）应用程序/ XML（用于.xml请求） |
用于接收响应的MIME类型格式。 | 应用程序/ XML |
内容类型 |
应用/ JSON.（对于JSON请求）应用程序/ XML（对于XML请求） |
请求身体的哑剧类型。用于验证和解析对API的请求。 | 应用/ JSON. |
用户代理 |
细绳 | 虽然不是必需的，但我们要求您指定一个用户代理，其中包含您的请求的集成/客户端。 | |
X-auth-token |
细绳 | 访问令牌授权应用程序访问资源代表用户。 |
响应标题
| 标题 | 可能的价值 | 描述 | 例子 |
|---|---|---|---|
日期 |
一个RFC 2822.日期。 | 响应已发送的日期。 | 星期二，2011年11月15日12:45:26 GMT |
最后修改 |
一个RFC 2822.日期。 | 资源上次修改的日期。请参阅各个资源页面以支持此标题。 | 星期二，2011年11月15日12:45:26 GMT |
内容类型 |
应用/ JSON. |
响应的MIME类型，取决于请求的端点的扩展。 | 应用/ JSON. |
内容位置 |
Uri. | 如果已重定向请求，则发送。 | /api/v2/orders/5.json. |
地点 |
Uri. | 新创建的资源的URI。用A发送201创建了回复。 |
/ API / V2 /产品/ 7 |
x-retry-arid |
整数 | 速率限制响应，指示配额刷新前的秒数。看速率限制想要查询更多的信息。 | 15. |
X-BC-ApiLimit剩余 |
整数 | 当前期间剩余的API请求数量（滚动一小时）。看速率限制想要查询更多的信息。 | 987. |
X-BC-Store版本 |
版本号 | 商店运行的BigCommerce版本。此头文件在7.3.6+版本中可用。 | 7.3.6 |
内容编码 |
GZIP. |
允许API客户端在响应API请求的响应之前请求要压缩的内容。 | GZIP. |
转移编码 |
钩 |
指定用于传输资源的编码的形式。 | 钩 |
X率限制 - 左 |
数字 | 详细说明在速率限制之前，您的客户端可以在当前窗口中携带多少剩余请求。在这种情况下，您希望能够在接下来的3000毫秒内进行更多的请求;在3000毫秒内的第7个请求中，您将获得速率限制，并将收到HTTP 429响应。 | 16101491. |
X率限制 - 请求 - 配额 |
数字 | 显示客户端的当前窗口中允许使用多少API请求。 | 16101495. |
X速率限制 - 时间重置-S |
数字 | 显示窗口中剩下多少毫秒。在这种情况下，3000毫秒 - 因此，在此请求后3000毫秒，API配额将被刷新。 | 30000 |
X速率限制 - 时间窗口-S |
数字 | 显示当前速率限制窗口的大小。 | 9762 |
媒体类型
媒体类型是请求或响应主体的格式。BigCommerce API接受请求并在JSON中响应。您应该使用UTF-8字符集进行编码请求（其他字符集可能具有不可预测的结果）。
内容类型
请求内容类型
执行包含正文（例如Post或Put）的请求时，需要在Content-Type标题中指定要发送的内容类型。
响应内容类型
有两种方式可以指定您想要接收的内容类型。第一个方法是指定接受标题。第二个是为您要请求的资源提供扩展。
您可以处理这些方法的优先级是：
- 接受标题高优先级类型（例如。
接受：应用/ JSON）资源上的扩展（例如客户.JSON.）。 - 接受标题低优先级类型（优先级小于1，例如，
接受：应用/ JSON; Q = 0.9）
请求结构
JSON请求的主体是包含一组键值对的对象。产品对象的简单表示是：
{“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”那“自定义网址”：{“URL”：“/花园/浴/”那“is_customized”：错误的}}那“meta”：{}}支持
开发人员社区
开发人员社区是从其他开发人员获得帮助的好地方，他们在大型商品平台上工作。如果您有特定于大型的问题，这个在线论坛是最好的要求。这也是初学者获得帮助的优秀场所。
堆栈溢出
您是一个更经验丰富的开发人员还是具有编程语言特定的问题？这个在线论坛是提出问题并获得帮助的好地方。开发人员社区是专门了解BigCommerce平台的最佳位置。