调用CreateAuthKey获取授权key,用于离线人脸识别SDK激活。
请求方法:支持以HTTPS POST和GET方法发送请求。
说明 授权key在30分钟内有效,且不可重复使用,建议在每次激活前重新获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateAuthKey |
要执行的操作。取值:CreateAuthKey。 |
BizType | String | 否 | FACE_TEST |
业务类型。不超过64字符。可用于对具体业务进行备注,例如可以取接入方不同的人脸使用场景,或者待交付的客户标识等。建议传入该参数。 |
UserDeviceId | String | 否 | 3iJ1AY$oHcu7mC69 |
用户设备ID。不超过64字符。可用于标识具体设备,建议可以使用设备物理编号。建议传入该参数。 |
Test | Boolean | 否 | false |
测试标识。为true表示使用测试授权,授权时长默认为30天;为false,则授权时长根据AuthYears进行授权。 |
AuthYears | Integer | 否 | 1 |
当Test标识为false或空时,AuthYears必填,单位为年,范围为[1,100],取值100表示永久授权。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
本次请求的ID。 |
AuthKey | String | auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$ |
可用于授权激活的key。授权key在30分钟内有效,且不可重复使用,建议在每次激活前重新获取。 |
示例
请求示例
https://cloudauth.aliyuncs.com/?Action=CreateAuthKey
&BizType=FACE_TEST
&UserDeviceId=3iJ1AY$oHcu7mC69
&Test=false
&AuthYears=1
&<公共请求参数>
正常返回示例
XML
格式
<CreateAuthKeyResponse>
<Data>
<AuthKey>auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$</AuthKey>
</Data>
<Success>true</Success>
<Code>1</Code>
</CreateAuthKeyResponse>
JSON
格式
{
"Data": {
"AuthKey":"auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$"
},
"Success": true
}
错误码
访问错误中心查看更多错误码。