跳到主要内容

认证说明

本 API 使用 OAuth 2.0 作为授权方式。

您的应用程序在用户授权时会询问特定的授权范围，并在用户批准后获得访问权限。

在您开始之前需要先注册您的应用程序，注册完成后系统将分配给您唯一的 uid 和 client_secret，用于 OAuth 授权。请注意，client_secret 需要妥善保存，不可分享给他人。

OAuth 流程 (Client Credentials 模式)​

第 1 步 - 使用商户号和 Client Secret 获得访问令牌（Access Token）​

您的应用程序服务器可通过获取的授权码（code）请求 /auth 接口以获取 Access Token。

接口地址请咨询销售。

接口参数如下：

  • grant_type：表示使用的授权模式，此处的值固定为 client_credentials（必选）
  • uid：在您注册应用程序时得到的商户号（必选）
  • client_secret：在您注册应用程序时得到的 client_secret（必选）

范例：

GET https://${domain_name}/mch-api/v1/auth?grant_type=client_credentials&uid=${your_uid}&client_secret=${your_client_secret}

您将接收到一个包含访问令牌 Access Token（以及其他详细信息）的 JSON 响应，范例如下：

HTTP/2 200 OK
Content-Type: application/json

{
    "access_token": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6",
    "expires_in": 3600
}

访问令牌默认 3600 秒过期，即 60 分钟，过期后重新获取访问令牌。

第 2 步 - 使用访问令牌访问 API 资源#​

您可以使用访问令牌调用本文档的 API 方法。

请求范例：

curl https://${domain_name}/mch-api/v1/resource -H 'Authorization: Bearer ${access_token}'

若访问令牌有效，服务端将返回给应用程序对应的数据。