概述
Postman是网页调试与辅助接口调用的工具,具有界面简洁清晰、操作方便快捷的特性,可以处理用户发送的HTTP请求,例如:GET,PUT、POST,DELETE等,支持用户修改HTTP请求中的参数并返回响应数据。
为充分了解接口,建议提前获取应用侧API参考查阅。我们已经写好了Postman的collection,在Collection中接口的请求结构体已经完成可以直接使用。
本文档以Postman为例,模拟应用服务器以HTTPS协议接入物联网平台,调测以下API接口:
前置条件
- 下载并安装Postman。若未安装,请参考安装Postman进行安装。
- 下载Collection。
- 已在管理控制台完成产品模型和编解码插件的开发。
安装并配置Postman
-
安装Postman。
-
访问Postman官网,下载并安装Windows 64位Postman最新版本。
说明:- 安装Postman依赖.NET Framework 4.5组件。
- 如需下载Windows 32位Postman最新版本,访问此处下载。
-
填写邮箱、用户名和密码注册Postman。
-
-
导入Postman环境变量。
-
单击右上角的
图标,打开"MANAGE ENVIRONMENTS"窗口。
-
单击"Import",在弹出的页面中,单击"选择文件",导入IoTDA.postman_environment.json 文件(下载**Collection** 解压后获取)。
-
单击导入的"IoTDA "环境。
-
参考下表修改以下参数。
参数名 参数说明 IAMEndpoint IAM终端节点,参考IAM地区和终端节点获取。 IoTDAEndpoint 物联网平台终端节点,参考2.e。 IAMUserName IAM用户名,参考我的凭证获取。 IAMPassword 登录华为云的密码。 IAMDoaminId 账号名,参考我的凭证获取。 region 开通设备接入服务的区域,参考物联网平台终端节点获取。 注意:账户与IAM的区别
-
IoTDAEndpoint参考。进入控制台,选择左侧导航栏"总览",单击"实例基本信息-接入信息",根据相应的接入类型和协议选择对应的接入地址。
图1总览-获取接入信息
-
返回主页,选择环境变量为刚导入的"IoTDA"。
-
-
单击左上角的"Import",单击"Choose Files"导入"应用侧API调用(V5版本).postman_collection.json "。
导入成功后,显示如下。
调测"获取IAM用户Token"接口
在访问物联网平台业务接口前,应用服务器需要调用"获取IAM用户Token"接口鉴权,华为云认证通过后向应用服务器返回鉴权令牌X-Subject-Token。
应用服务器需要构造一个HTTP请求,请求示例如下:
POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username", IAM账号
"password": "********", IAM密码
"domain": {
"name": "domainname" 账号名
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx" 项目区域:如:cn-north-4
}
}
}
}
参考API文档,调测获取IAM用户Token接口。
-
配置"获取IAM用户Token"接口的HTTP 方法、URL 和Headers 。
注意:红字需要填写实际配置
-
配置"获取IAM用户Token"接口的Body 。
-
单击"Send",在下方查看返回码和响应消息内容。
-
请将返回头域中的的X-Subject-Token 更新到"IoTDA "环境的"X-Auth-Token "参数中,以便于在调用其它接口时使用。若超过令牌有效时间,需要重新调用鉴权接口。
这里我们已经在postman中自动更新了"X-Auth-Token"参数,使用时无需手动操作。