简介

Mshop 提供了一套API,使开发人员可以扩展平台的内置功能。这些API允许合作伙伴读取和写入商家数据,与其他系统和平台进行相互操作以及向 Mshop 添加新功能。

使用API的要求

  • 所有 API 均需遵守 Mshop API 许可和使用条款

  • 所有 API 均受速率限制,具体限制方式见使用说明部分的速率限制章节。

  • 所有 API 都要求开发人员进行身份验证

  • 所有 API 已版本化

API身份验证

为了确保平台上的数据安全可靠,进行 API 调用时,所有与我们 API 连接的应用都必须进行身份验证

认证类型

平台对应用进行身份验证的使用 Access-Token 验证。目前开放给第三方的称为私有应用。

私有应用的 Access-Token 验证

私有应用使用基本的 Access-Token 验证,在管理后台应用市场内创建私有应用以获取 Access-Token,然后使用调用API中提到的方式进行API调用。API版本指的是生成Webhook消息的 API版本,具体信息如下图所示:

API使用方法

在请求头中,带上 Authorization: Bearer <token>完成授权,

curl -i -X GET \
     -H "Content-Type:application/json" \
     -H "Authorization:Bearer <token>"  \
     'https://store.hotishop.com/openapi/2021-08/orders'

scope列表

  • read_products, write_products

  • read_orders, write_orders

  • read_customers, write_customers

  • read_collections, write_collections

  • read_script_tags,write_script_tag

scopes 详情请查看 权限列表

API版本控制

Mshop 平台由于迭代开发速度很快,将会提供不同的API版本。

了解有关 API版本控制 更多信息

发布时间表

发布版本

发布时间点

不再支持版本日期

备注

2021-08

2021年08月01日

2024年04月01日

调用此版本自动滚动至最旧稳定版本

2023-10

2023年10月01日

2025年04月01日

最旧稳定版本

2024-10

2024年10月01日

2025 年 10 月01 日

最新稳定版本

2025-04

2024年10月01日

2026年04月01日

开发版本

带版本的API调用

RESTful API URL: /openapi/{version}/{endpoint}

例如,以下 URL 调用 version 2021-08

RESTful API URL: /openapi/2021-08/products

Last updated