为了降低应用侧的开发难度、提升应用侧开发效率，物联网平台向应用侧开放了 API。开发者可以调用开放的 API，快速集成物联网平台的功能，如产品管理、设备管理、订阅管理、设备
命令、规则管理等功能。

应用侧需先通过 IAM 服务鉴权，获取 Token 后，方可实现相关产品管理、设备管理等功能。

 如何调用 API

华为云物联网平台提供多样的北向 Restful API 接口给应用开发者，方便应用开发者能够基于平台提供的能力快速开发出物联网应用。

 构造请求

请求 URI 由如下部分组成：

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求 URI 包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

URI-scheme：表示用于传输请求的协议，当前所有 API 均采用 HTTPS 协议。
Endpoint：指定承载 REST 服务端点的服务器域名或 IP，不同服务不同区域的 Endpoint 不同，您可以从地区和终端节点中获取。例如物联网平台在“华北-北京四”区域的 Endpoint 为
“iotda.cn-north-4.myhuaweicloud.com”。
resource-path：资源路径，也即 API 访问路径。从具体 API 的 URI 模块获取，例如“查询产品”API 的 resource-path 为“/v5/iot/{project_id}/products/{product_id}”。
query-string：查询参数，是可选部分，并不是每个 API 都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过 10 条数据。
例如您需要在物联网平台获取在“华北-北京四”区域下的指定产品信息，则需使用“华北-北京四”区域的 Endpoint（iotda.cn-north-4.myhuaweicloud.com），并在查询产品的 URI 部分找到 resource-path（/v5/iot/{project_id}/products/{product_id}），拼接起来如下所示。

https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id}

请求方法

HTTP 请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
GET：请求服务器返回指定资源。
PUT：请求服务器更新指定资源。
POST：请求服务器新增资源或执行特殊操作。
DELETE：请求服务器删除指定资源，如删除对象等。
HEAD：请求服务器资源头部。
PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH 可能会去创建一个
新的资源。
在查询产品的 URI 部分，您可以看到其请求方法为“GET”，则其请求为：

GET https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id}

请求消息头

附加请求头字段，如指定的 URI 和 HTTP 方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
X-Auth-Token：用户 Token。当使用 Token 方式认证时，必须填充该字段，可通过调用获取用户 Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。
对于查询产品接口，由于需要认证，所以需要添加“Content-Type”和“X-Auth-Token”到头域，添加消息头后的请求如下所示。

GET https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id}
Content-Type: application/json
X-Auth-Token：******

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中 Content-type 对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为 UTF-8 编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE 操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而
定。
对于创建产品接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，如：其中 name 为产品名称，device_type 为设备类型，protocol_type 为设备使用的协议类型。

POST https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/abab***cdcd/products
Content-Type: application/json 
X-Auth-Token: ********
{
 "name" : "Thermometer",
 "device_type" : "Thermometer",
 "protocol_type" : "MQTT",
 "data_format" : "binary",
 "manufacturer_name" : "ABC",
 "industry" : "smartCity",
 "description" : "this is a thermometer produced by Huawei",
 "service_capabilities" : [ {
 "service_type" : "temperature",
 "service_id" : "temperature",
 "description" : "temperature",
 "properties" : [ {
 "unit" : "centigrade",
 "min" : "1",
 "method" : "R",
 "max" : "100",
 "data_type" : "decimal",
 "description" : "force",
 "step" : 0.1,
 "enum_list" : [ "string" ],
 "required" : true,
 "property_name" : "temperature",
 "max_length" : 100
 } ],
 "commands" : [ {
 "command_name" : "reboot",
 "responses" : [ {
 "response_name" : "ACK",
 "paras" : [ {
 "unit" : "km/h",
 "min" : "1",
 "max" : "100",
 "para_name" : "force",
 "data_type" : "string",
 "description" : "force",
 "step" : 0.1,
 "enum_list" : [ "string" ],
 "required" : false,
 "max_length" : 100
 } ]
 } ],
 "paras" : [ {
 "unit" : "km/h",
 "min" : "1",
 "max" : "100",
 "para_name" : "force",
 "data_type" : "string",
 "description" : "force",
 "step" : 0.1,
 "enum_list" : [ "string" ],
 "required" : false,
 "max_length" : 100
 } ]
 } ],
 "option" : "Mandatory"
 } ],
 "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}

 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。
Token 认证：通过 Token 认证通用请求。
AK/SK 认证：通过 AK（Access Key ID）/SK（Secret Access Key)加密调用请求。
Token 认证：
Token 是服务端生成的一串字符串，作为客户端进行请求的一个令牌。第一次登录后，服务器生成一个 Token 并将此 Token 返回给客户端，以后客户端只需带上这个 Token 前来请求数据即可，无需再次带上用户名和密码。Token 有效期是 24 小时，从客户端获取开始算起（24 小时是相对时间），需要使用同一个 Token 鉴权时，建议缓存起来使用，避免频繁调用。在 Token 过期前，务必刷新 Token 或重新获取 Token，否则 Token 过期后会在服务端鉴权失败。

如果您获取 Token 多次，以最新的为准，前面的 Token 会被覆盖并失效。Token 在计算机系统中代表令牌（临时）的意思，拥有 Token 就代表拥有某种权限。Token认证就是在调用 API 的时候将 Token 加到请求消息头，从而通过身份认证，获得操作 API 的权限。
调用获取 IAM 用户 Token（使用密码）接口获取 Token，调用样例如下：

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 
Content-Type: application/json 
{ 
 "auth": { 
 "identity": { 
 "methods": [ 
 "password" 
 ], 
 "password": { 
 "user": { 
 "name": "username", 
 "password": "********", 
 "domain": { 
 "name": "domainname" 
 } 
 } 
 } 
 }, 
 "scope": { 
 "project": { 
 "name": "xxxxxxxx" 
 } 
 } 
 } 
}

注：“username”即 IAM 用户名、“password”即登录华为云密码、“domainname”即账号名，“projectname”项目。

接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户 Token。获取 Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值为获取到的 Token。例如 Token 值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。

GET https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id}
Content-Type: application/json 
X-Auth-Token: ABCDEFJ....

AK/SK 认证:
AK/SK 签名认证方式仅支持消息体大小 12M 以内，12M 以上的请求请使用 Token 认证。
AK/SK 认证就是使用 AK/SK 对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。
AK(Access Key ID)：访问密钥 ID。与私有访问密钥关联的唯一标识符；访问密钥 ID 和私有访问密钥一起使用，对请求进行加密签名。
SK(Secret Access Key)：与访问密钥 ID 结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
使用 AK/SK 认证时，您可以基于签名算法使用 AK/SK 对请求进行签名，也可以使用专门的签名 SDK 对请求进行签名。
签名 SDK 只提供签名功能，与服务提供的 SDK 不同，使用时请注意

返回结果

状态码：
请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。
状态码是一组从 1xx 到 5xx 的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。
对于创建产品接口，如果调用后返回状态码为“201”，则表示请求成功。
响应消息头：
对应请求消息头，响应同样也有消息头，如“Content-type”等。
对于创建产品接口，平台会返回“Content-type”、Date 等消息头。
响应消息体：
响应消息体通常以结构化格式返回，与响应消息头中 Content-type 对应，传递除响应消息头之外的内容。