公告:融云新文档中心已上线,欢迎到新文档中心阅读 IM 服务端文档。
获取 JWT Token
更新时间:2024-04-08
PDF
本文描述如何从即时通讯服务端获取翻译插件鉴权专用的 JWT(JSON Web Token)。JWT 是一种基于 JSON 的轻量级开放标准,用于在网络应用之间安全地传输声明信息。JWT 由三个主要部分组成:头部(Header)、负载(Payload)和签名(Signature)。Payload 包含了 JWT 的主体信息,通过解析可获得 JWT 的有效期(两个小时)、UserId 等信息。
翻译插件鉴权专用的 JWT Token 不同于 IM 用户连接 IM 服务的 Token,请注意区分。
- 该接口暂仅适用于使用新加坡数据中心的应用。详见海外数据中心。
- 调用该接口必须使用专用的 API 域名: https://ai.sg-light-edge.com
适用场景
即时通讯业务客户端 SDK 提供了翻译插件,可为 IMLib 与 IMKit SDK 快速接入外部翻译服务。客户端从 App 后端获取有效的 JWT,才能向即时通讯服务端请求翻译结果。
即时通讯服务端提供了获取 JWT 的 API 接口。该接口必须由 App 后端调用,成功获取 JWT 后由 App 后端返回给客户端。
获取和刷新 JWT 流程图
请求方法
POST: https://ai.sg-light-edge.com/jwt/getToken.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户Id |
请求示例
POST /jwt/getToken.json HTTP/1.1
Host: ai.sg-light-edge.com
App-Key: your-own-app-key
Nonce: 14314
Timestamp: 1408710653000
Signature: 30be0bbca9c9b2e27578701e9fda2358a814c88f
Content-Type: application/x-www-form-urlencoded
Content-Length: 78
userId=jlk456j5
已复制
1
2
3
4
5
6
7
8
9
10
11
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
token | String | 返回的JWT |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200,"token":""}
已复制
1
2
3
4