如何使用OpenAPI
- 创建应用获取访问令牌。
- 订阅API。
- 访问API。
- 根据创建的应用令牌信息,请求获取ISDP+的Token。
- 通过获取的ISDP+的Token请求对应的API数据。
订阅OpenAPI
获取ISDP+ Token
ISDP+的Token由access_token和token_type组合而成,用于调用其他ISDP+ OpenAPI时鉴权。
ISDP+的Token:token_type access_token
- 【请求URL】
请求URL由如下部分组成。
{URL-scheme}://{Endpoint}/{resource-path}?{query-string}
表1 请求URL 参数
说明
URI-scheme
表示用于传输请求的协议,当前所有API均采用HTTPS协议。
Endpoint
指定承载REST服务端点的服务器域名或IP。
例如ISDP+测试环境服务器的Endpoint为“isdpcloud-beta.sd.huawei.com”。
resource-path
资源路径,即API访问路径。从具体API的URL模块获取,“获取ISDP+Token”API的resource-path为“/oauth2/oauth/rest_token”。
query-string
查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。
需要获取ISDP+的Token,“/oauth2/oauth/rest_token”为资源路径,假设ISDP+测试环境域名为“isdpcloud-beta.sd.huawei.com”,URL拼接起来如下所示。
https://isdpcloud-beta.sd.huawei.com/oauth2/oauth/rest_token
- 【请求方法】
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
表2 HTTP请求方法 方法
说明
GET
请求服务器返回指定资源。
PUT
请求服务器更新指定资源。
POST
请求服务器新增资源或执行特殊操作。
DELETE
请求服务器删除指定资源。
HEAD
请求服务器资源头部。
PATCH
请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
在获取ISDP+ Token的URL部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://isdpcloud-beta.sd.huawei.com/oauth2/oauth/rest_token
- 【请求消息头】
附加请求头字段,如指定的URL和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
详细的公共请求消息头字段请参见表3。
表3 公共请求消息头 消息头名称
描述
是否必选
Content-Type
消息体的类型(格式),HTTP协议中设定的一个参数,用于标识返回的内容用什么格式去解析。
是
Authorization
ISDP+的Token,调用ISDP+的API要用到的访问令牌,在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
否
对于获取ISDP+ Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。POST https://isdpcloud-beta.sd.huawei.com/oauth2/oauth/rest_token Content-Type: application/json
- 【请求消息体】
请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于获取ISDP+ Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。
将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中***********为应用ID,xxxxxxxxxx为应用令牌,获取方法请参见创建应用。
POST https://isdpcloud-beta.sd.huawei.com/oauth2/oauth/rest_token Content-Type: application/json { "client_id": "isdp-saas-openapi", "client_secret": "isdp-saas-openapi", "grant_type": "password", "username": "**********", "password": "xxxxxxxxxx" }
- 【发起请求】
对于获取ISDP+ Token接口,返回的响应消息体中“access_token”和“token_type”就是组成ISDP+ Token的值。有了Token之后,您就可以使用Token认证调用其他ISDP+ OpenAPI。
图7 响应消息
ISDP+ Token=“token_type access_token”(注意两个字段之间有空格)。