接口说明
请求URI
/editorPlugin/base/getUserInfoByToken
功能描述
根据插件token获取用户信息
注意事项
注意：环境域名
调用方式
HTTPS 调用
GET https://integrate.rabbitpre.com/api/open/editorPlugin/base/getUserInfoByToken
请求数据类型
[ "application/json" ]
响应数据类型
[ "*/*" ]
请求头参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Token | string | 是 | 自建应用访问token |
请求体参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orgId | string | 否 | 企业ID |
| appInstanceId | int64 | 否 | 应用实例ID |
| nonce | string | 是 | 6位随机字符串 |
| timestamp | int64 | 是 | unix时间戳(毫秒) |
| pluginToken | string | 是 | 插件token |
返回参数
属性 | 类型 | 说明 |
|---|---|---|
code | string | 响应状态码。200-请求成功， 100100-appid、secret错误， 100200-token错误 ，100300-授权code错误 |
data | Object | 数据对象 |
| └─appId | string | 兔展作品ID |
| └─audid | string | 兔展玩家客户档案ID |
| └─browser | int64 | 浏览器, e.g. Weixin6.7.3 |
| └─cnlDeptId | 传播的部门ID | |
| └─cnlId | 传播渠道Id | |
| └─cnlType | 传播渠道类型 | |
| └─device | 设备类型，按操作系统区分, e.g. iOS/Android | |
| └─deviceBrand | 设备品牌，e.g. xiaomi/apple | |
| └─deviceOs | 设备操作系统版本, e.g. iOS9.1 | |
| └─leaderId | 队伍Id | |
| └─orgId | 兔展企业ID | |
| └─pfid | 兔展企业唯一标识ID | |
| └─splayRecordId | 来源参与记录Id | |
| └─unionid | unionid | |
| └─openid | openid | |
errorCode | string | 错误码 |
msg | string | 消息提示 |
根据插件token获取用户信息
接口地址 /api/open/editorPlugin/base/getUserInfoByToken
请求方式 GET
consumes ["application/json"]
produces ["*/*"]
接口描述 企业级接口，hearer必须携带X-Token
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| X-Token | 自建应用访问token | header | true | string | |
| orgId | 企业ID | query | false | string | |
| appInstanceId | 应用实例ID | query | false | integer | |
| nonce | 6位随机字符串 | query | true | string | |
| timestamp | unix时间戳(毫秒) | query | true | integer | |
| pluginToken | query | false | string |
响应状态
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ApiResponse«PluginTokenDto» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | string | ||
| data | PluginTokenDto | PluginTokenDto | |
| errorCode | string | ||
| msg | string |
schema属性说明
PluginTokenDto
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| appId | 作品id | string | |
| audid | 客户ID | string | |
| browser | 浏览器, e.g. Weixin6.7.3 | string | |
| cnlDeptId | 传播的部门ID | string | |
| cnlId | 传播渠道Id | string | |
| cnlType | 传播渠道类型 | string | |
| device | 设备类型，按操作系统区分, e.g. iOS/Android | string | |
| deviceBrand | 设备品牌，e.g. xiaomi/apple | string | |
| deviceOs | 设备操作系统版本, e.g. iOS9.1 | string | |
| leaderId | 队伍Id | string | |
| orgId | 企业ID | string | |
| pfid | 企业pfid | string | |
| splayRecordId | 来源参与记录Id | string | |
| unionid | unionid | string | |
| openid | openid | string |
响应示例
{
"code": "",
"data": {
"appId": "",
"audid": "",
"browser": "",
"cnlDeptId": "",
"cnlId": "",
"cnlType": "",
"device": "",
"deviceBrand": "",
"deviceOs": "",
"leaderId": "",
"orgId": "",
"pfid": "",
"splayRecordId": ""
},
"errorCode": "",
"msg": ""
}