帮你快速理解、总结文档立即下载

调用 API

最近更新时间:2026-08-06 17:44:30
我的收藏

操作场景

本文介绍如何通过 Postman 工具,使用不同鉴权方式从用户侧调用已发布的 API 服务。API 服务支持免鉴权、BasicAuth、OAuth2.0 和 HMAC Auth 四种鉴权方式,您可根据 API 服务配置的鉴权类型,选择对应的调用方法。

前提条件

已成功发布 API 服务。
已安装 Postman 工具。

操作步骤

免鉴权方式

在 Postman 中填入 API 的调用地址,单击 Send,即可直接调用 API。


BasicAuth 方式

1. 复制 API 的调用地址(需先成功发布 API 服务)。

2. 进入 API 服务详情页面,新建或打开已有调用凭证,查看用于 BasicAuth 的 AK/SK 信息。

3. 打开 Postman,将上述获取的 API 调用地址和用于 Basic Auth 的 AK/SK 信息分别填入对应位置,单击 Send,即可调用 API。


OAuth2.0 方式

1. 复制 API 的调用地址,方法同 BasicAuth 方式步骤1
2. 进入 API 服务详情页面,新建或打开已有调用凭证,查看用于 OAuth2.0 的 AK/SK 信息。

3. 进入 API 服务详情页面,单击并复制对应 API 的 Token 获取链接。

4. 在 Postman 中创建一个新的请求,获取 access_token。
4.1 在输入栏中输入步骤3获取的 Token 获取链接,选择 GET 请求方法。
4.2 选择 Params 标签页,分别输入步骤2获得的用于 OAuth2.0 的 AK/SK 信息(格式见下图)。
4.3 单击 Send,即可生成 access_token,将其复制保存。

5. 在 Postman 中重新打开一个请求界面,填入步骤1获取的 API 调用地址,Type 选择 OAuth2.0 模式。在右侧填入步骤4获取的 access_token,单击 Send,即可看到访问结果。
说明:
如果配置 API 时设置了请求参数,需在对应位置输入请求参数。

6. 当 access_token 过期(24 小时)后,需借助 refresh_token 获取新的 access_token。在步骤4中 access_token 接口的返回值中会包含 refresh_token,利用 refresh_token 请求 refresh_token 接口,即可获取最新的 access_token。


HMAC Auth 方式

1. 复制 API 的调用地址,方法同 Basic Auth 方式步骤1
2. 进入 API 服务详情页面,新建或打开已有调用凭证,查看用于 HMAC 的 AK/SK 信息。

3. 打开 Postman,在输入框中填入步骤1获取的 API 调用地址。
4. 将 Postman 切换到 Pre-request Script 标签下,粘贴下方代码段。
说明:
请用步骤2获取的 HMAC 的 Key 和 Secret,分别替换代码段中的 hmac_key 和 hmac_secret 变量值。

var hmac_key = "2e4d0bbad47e3b5e3a0c";
var hmac_secret = "815ba6d666d58ef1e79b";
var time = new Date().toUTCString();
console.log("time:" + time)
var signed_headers_string = "";
signing_string= pm.request.method + "\\n" + pm.request.url.getPath() + "\\n" + pm.request.url.getQueryString() + "\\n" + hmac_key + "\\n" + time + "\\n" + signed_headers_string;
console.log("signing_string:\\n" + signing_string);
var signatureBytes = CryptoJS.HmacSHA256(signing_string, hmac_secret);
var requestSignatureBase64String = CryptoJS.enc.Base64.stringify(signatureBytes);
console.log("requestSignatureBase64String:" + requestSignatureBase64String)
//将下面变量记录下来,在请求的Header中进行引用
pm.globals.set("sign", requestSignatureBase64String); //hmac签名
pm.globals.set("hmac_key", hmac_key); //hmac key
pm.globals.set("date", time); //请求时间
5. 将 Postman 切换到 Headers 标签下,输入下图中所示的4个 KEY-VALUE 对。单击 Send,即可看到调用 API 的返回结果。