• 沒有找到結果。

本节介绍REST API请求的组成,并以调用人证核身(三要素)接口为例说明如何调用 API,该API获取用户的Token,Token可以用于调用其他API时鉴权。

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

bbs.huaweicloud.com/videos/102987 。

请求 URI

请求URI由如下部分组成。

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

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

3-1 URI 中的参数说明

参数 说明

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

endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的 endpoint不同,您可以从地区和终端节点获取。

例如IVS服务在“华北-北京四”区域的“endpoint”为“ivs.cn-north-4.myhuaweicloud.com”。

resource-path 资源路径,也即API访问路径。

从具体API的URI模块获取,例如人证核身标准版(三要素)API的

“resource-path”为“/v2.0/ivs-standard”。

query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前 面需要带一个“?”,形式为“参数名=参数取值”,例如

“limit=10”,表示查询不超过10条数据。

例如,您需要在“华北-北京四”区域调用人证核身标准版(三要素)API,则需使用

“华北-北京四”区域的Endpoint(ivs.cn-north-4.myhuaweicloud.com),并在标准 版(三要素)的URI部分找到resource-path(/v2.0/ivs-standard),拼接起来如下所 示。

https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard

3-2 URI 示意图

说明

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。

这是因为URI-scheme都是HTTPS,而endpoint在同一个区域也相同,所以简洁起见将这两部分 省略。

请求方法

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

3-2 HTTP 方法

方法 说明

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

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

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

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

HEAD 请求服务器资源头部。

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

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

人证核身标准版(三要素)的URI部分,您可以看到其请求方法为“POST”,则其请 求为:

POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard

请求消息头

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

如下公共消息头需要添加到请求中。

Content-Type:消息体的类型(格式),必选,默认取值为“application/

json”,有其他取值时会在具体接口中专门说明。

X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字 段。用户Token请参考认证鉴权。

添加消息头后的请求如下所示。

POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard Content-Type: application/json

x-auth-token: MIIaBgYJKoZIhvcNAQcC……

请求消息体

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

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

对于人证核身标准版(三要素)接口,您可以从接口的请求部分看到所需的请求参数 及参数说明。将消息体加入后的请求如下所示。

POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard Request Header:

Content-Type: application/json

X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

Request Body:

{ "meta": {

"uuid": "user_defined"

}, "data": { "req_data": [ {

"idcard_image1": "/9j/4AAQSkZJRgABAgEASA...", "idcard_image2": "/9j/4AAAAABQSkZJRgABAgEASB...", "face_image": "/9j/4BBQSkZJRgABAgEASB..."

}

● Token认证:通过Token认证调用请求。

● AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。

Token 认证

username

为用户名,

domainname

为用户所属的账号名称,

********

为用户登录密 码,

project name

为项目名称。username,domainname和project name的获取方 法参见获取用户名、用户ID、项目名称、项目ID。

获取Token的终端节点和

project name

需与IVS服务终端节点保持一致。当访问华北-北京四的终端节点(即访问https://ivs.cn-north-4.myhuaweicloud.com时),获取 Token请使用终端节点https://iam.

cn-north-4

.myhuaweicloud.com,

project name

cn-north-4

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

Request Body:

{ "auth": {

相關文件