更新时间:2024-02-29 GMT+08:00
分享

构造请求

本节介绍REST API请求的组成,并以调用获取Access Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API。

您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987

请求URI

请求URI由如下部分组成:

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

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

表1 请求URI

参数

说明

URI-scheme

表示用于传输请求的协议,当前所有API均采用HTTPS协议。

domain_name

使用OrgID的公网访问域名,OrgID的公网访问域名为“orgid.huaweiapaas.cn”。

resource-path

资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取Access Token”API的resource-path为“/orgid/openapi/v1/oauth2/token”,其中“/orgid/openapi”可省略。

query-string

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。

例如您需要获取用户访问OrgID的Access Token,则需使用OrgID的公网访问域名(orgid.huaweiapaas.cn),并在获取Access Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。

https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/token
图1 URI示意图

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而domain_name在同一个区域也相同,所以简洁起见将这两部分省略。

请求方法

HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。

表2 HTTP方法

方法

说明

GET

请求服务器返回指定资源。

PUT

请求服务器更新指定资源。

POST

请求服务器新增资源或执行特殊操作。

DELETE

请求服务器删除指定资源,如删除对象等。

HEAD

请求服务器资源头部。

PATCH

请求服务器更新资源的部分内容。

当资源不存在的时候,PATCH可能会去创建一个新的资源。

在获取Access Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:

POST https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/token

请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

需要添加到请求中的公共消息头如表3所示。

表3 公共请求消息头

参数名

说明

是否必选

示例

Content-type

消息体的类型(格式),默认取值为“application/x-www-form-urlencoded”。

application/x-www-form-urlencoded

对于获取Access Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。

POST https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/token 
Content-Type: application/x-www-form-urlencoded

请求消息体

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

对于获取Access Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,client_id为创建应用后OrgID提供的client_id,client_secret为创建应用后OrgID提供的client_secret,redirect_uri为创建自建应用时配置的首页URL,code为OrgID给用户颁发的code,可以在创建应用后应用的“登录配置”页面该应用的首页URL中获取。

POST https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/token 
Content-Type: application/x-www-form-urlencoded
 
{ 
  grant_type:authorization_code
  client_id:client_id
  client_secret:client_secret
  redirect_uri:redirect_uri
  code:code
}

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。对于获取Access Token接口,返回的响应消息体中“access_token”就是需要获取的Access Token。有了Token之后,您就可以使用Token认证调用其他API。

分享:

    相关文档

    相关产品