签发一次性会话 ticket - CreateEmbedAuthSessionTicket
功能介绍
签发一次性会话ticket,用于建立会话。
URI
POST /v1/app/auth/session/ticket
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 认证凭证。 约束限制: 格式:Bearer {access_token}。 取值范围: [1-1024]个字符。 默认取值: 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释: APP ID。 约束限制: 不涉及。 取值范围: [1-128]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| ticket | String | 参数解释: 一次性凭证。 取值范围: [1-256]个字符。 |
| expires_in | Integer | 参数解释: 一次性凭证有效期,单位:秒。 取值范围: [1-3600]。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
使用请求头中的Authorization字段的值换取一次性ticket。
https://{Endpoint}/v1/app/auth/session/ticket 响应示例
状态码:200
{
"ticket" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"expires_in" : 120
} 状态码:400
{
"error_code" : "KPGE.00001000",
"error_msg" : "Parameter error."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 错误响应。 |
| 500 | 错误响应。 |
错误码
请参见错误码。