跳到主要内容

以secret获取token

简要描述

  • 获取用户或 APP 管理员token。

⚠️ 注意: OpenIMServer 内置了一个APP 管理员,它的 userIDimAdmin

请求方式

  • post

请求URL

  • http://x.x.x.x:10002/auth/user_token
header名示例值选填类型说明
operationID1646445464564必填stringoperationID用于全局链路追踪

请求参数示例

{
"secret": "openIM123",
"platformID": 1,
"userID": "111111"
}
字段名选填类型说明
secret必填stringopenIM 密钥,见config/config.yaml中secret字段
platformID必填int平台ID, 1:IOS,2:Android,3:Windows,4:OSX,5:Web,6:MiniWeb,7:Linux,8:Android Pad,9:IPad,10:admin
userID必填string用户ID或管理员ID, 如生成管理员token, 需填写 imAdmin

成功返回示例

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiJvcGVuSU1BZG1pbiIsIlBsYXRmb3JtSUQiOjEsImV4cCI6MTY5Njc1NDgwNSwibmJmIjoxNjg4OTc4NTA1LCJpYXQiOjE2ODg5Nzg4MDV9.SAu86X3PzfYjtjBeYA4vZefNr1IiFKRgg12FeiXSm14",
"expireTimeSeconds": 7776000
}
}

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象,具体结构见下方
tokenstring获取到的用户token
expireTimeSecondsstringtoken的过期时间(单位秒)

失败返回示例

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息