最近更新时间:2021-06-22
1 调用说明
语音技术提供了REST API,支持通过发送HTTPS请求调用。调用方式为向API服务地址使用POST发送请求,在请求参数头域中需要加上应用的Token参数来进行鉴权。
Token代表了您创建的应用,与应用一一对应。调用服务接口需要在请求添加如下头部信息表明调用者身份:
Authorization: Bearer
下面两个接口介绍Token的获取以及Token的废除。系统暂时没有提供Token刷新的机制,不过可以先调用废除Token然后再生成Token来完成Token的刷新。目前Token的有效时间是3600秒,您可以调用获取Token的API得到Token的剩余存活时间,在Token即将过期时,调用废除Token的API废弃当前Token,再调用获取Token的API得到新Token。
下面是两个接口的具体介绍。
用于获取应用的Token信息,并将Token和剩余存活时间返回给您。
调用地址:https://apim.unicloud.com/token
请求方式:POST
返回类型:JSON
Header如下:
参数 | 值 | 说明 |
---|---|---|
Content-Type | application/x-www-form-urlencoded | -- |
Authorization | Basic | "Consumer Key:Consumer Secret"的Base64位编码 |
注:Consumer Key和Consumer Secret从页面上,管理控制台->应用列表->应用名称所对应的那行信息上来获取。
Query如下:
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
grant_type | true | string | client_credentials | 值唯一 |
Body无内容,但是注意:Body设置成x-www-form-urlencoded格式
curl -k -d "grant_type=client_credentials" \ -H "Authorization: Basic cEJ6dUlaaEdwaGZRbWRjVVgwbG5lRmlpdXh3YTo0U0pnV19qTU56aGpIU284OGJuZVhtTnFNMjRh" \ -H "Content-Type: application/x-www-form-urlencoded" \ https://apim.unicloud.com/token
curl -k -d "grant_type=client_credentials" \ -H "Authorization: Basic cEJ6dUlaaEdwaGZRbWRjVVgwbG5lRmlpdXh3YTo0U0pnV19qTU56aGpIU284OGJuZVhtTnFNMjRh" \ -H "Content-Type: application/x-www-form-urlencoded" \ https://apim.unicloud.com/token
curl -k -d "grant_type=client_credentials" -H "Authorization: Basic cEJ6dUlaaEdwaGZRbWRjVVgwbG5lRmlpdXh3YTo0U0pnV19qTU56aGpIU284OGJuZVhtTnFNMjRh" -H "Content-Type: application/x-www-form-urlencoded" https://apim.unicloud.com/token
curl -k -d "grant_type=client_credentials" -H "Authorization: Basic cEJ6dUlaaEdwaGZRbWRjVVgwbG5lRmlpdXh3YTo0U0pnV19qTU56aGpIU284OGJuZVhtTnFNMjRh" -H "Content-Type: application/x-www-form-urlencoded" https://apim.unicloud.com/token
字段 | 类型 | 说明 |
---|---|---|
access_token | string | Token值 |
scope | string | 在Consumer Key和Consumer Secret所对应的应用中生效 |
token_type | string | Token类型,是Bearer类型 |
expires_in | string | 代表了当前Token的剩余存活时间,单位为秒 |
{ "access_token":"4c27f899-6f9c-3217-b974-3ceb5a409ac3", "scope":"am_application_scope default", "token_type":"Bearer", "expires_in":723 }
{ "access_token":"4c27f899-6f9c-3217-b974-3ceb5a409ac3", "scope":"am_application_scope default", "token_type":"Bearer", "expires_in":723 }
{ "access_token":"4c27f899-6f9c-3217-b974-3ceb5a409ac3", "scope":"am_application_scope default", "token_type":"Bearer", "expires_in":723 }
{"access_token":"4c27f899-6f9c-3217-b974-3ceb5a409ac3","scope":"am_application_scope default","token_type":"Bearer","expires_in":723}
用于废除应用的Token信息,废除后此Token不再生效。
调用地址:https://apim.unicloud.com/revoke
请求方式:POST
返回类型:JSON/EMPTY_BODY
Header如下:
参数 | 值 | 说明 |
---|---|---|
Content-Type | application/x-www-form-urlencoded | -- |
Authorization | Basic | "Consumer Key:Consumer Secret"的Base64位编码 |
注:Consumer Key和Consumer Secret从页面上,管理控制台->应用列表->应用名称所对应的那行信息上来获取。
Query如下:
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
token | true | string | -- | 您之前获取的token |
Body无内容。
curl -k -v -d "token=c8e8eec2-0092-3ac6-b23f-ef7492f345a6" \ -H "Authorization: Basic OVRRNVJLZWFhVGZGeUpRSkRzam9aZmp4UkhjYTpDZnJ3ZXRual9ZOTdSSzFTZWlWQWx1aXdVVmth" \ -H "Content-Type: application/x-www-form-urlencoded" \ https://apim.unicloud.com/revoke
curl -k -v -d "token=c8e8eec2-0092-3ac6-b23f-ef7492f345a6" \ -H "Authorization: Basic OVRRNVJLZWFhVGZGeUpRSkRzam9aZmp4UkhjYTpDZnJ3ZXRual9ZOTdSSzFTZWlWQWx1aXdVVmth" \ -H "Content-Type: application/x-www-form-urlencoded" \ https://apim.unicloud.com/revoke
curl -k -v -d "token=c8e8eec2-0092-3ac6-b23f-ef7492f345a6" -H "Authorization: Basic OVRRNVJLZWFhVGZGeUpRSkRzam9aZmp4UkhjYTpDZnJ3ZXRual9ZOTdSSzFTZWlWQWx1aXdVVmth" -H "Content-Type: application/x-www-form-urlencoded" https://apim.unicloud.com/revoke
curl -k -v -d "token=c8e8eec2-0092-3ac6-b23f-ef7492f345a6" -H "Authorization: Basic OVRRNVJLZWFhVGZGeUpRSkRzam9aZmp4UkhjYTpDZnJ3ZXRual9ZOTdSSzFTZWlWQWx1aXdVVmth" -H "Content-Type: application/x-www-form-urlencoded" https://apim.unicloud.com/revoke
无
httpsCode = 200表示成功,其他表示失败。