基于员工获取sessionId接口
- 接口：由第三方提供，我们配置到系统中。
- Method：POST
- 数据格式：JSON
- 接口说明：此接口用于生成基于员工的身份令牌，目前是基于员工的token接口。此接口与基于租户获取sessionId的接口相斥。
- 文末有版本说明
请求参数
| 字段 |
类型 |
释义 |
必填 |
| account |
String |
账户 |
是 |
| secret |
String |
账户密码 |
是 |
| timestamp |
long |
13位时间戳的请求时间，如果此时间与当前时间相差较大，则判定请求失效。 |
是 |
| platform |
String |
渠道与source一致，后续逐渐废弃，建议渠道均优先使用source |
是 |
| source |
String |
渠道 |
是 |
| userId |
Integer |
云简的员工号,历史数据,短期需要兼容（针对一些渠道必须有人员才能获取session，否则不需要验证这个参数） |
FLASE |
| userNo |
String |
渠道对接的员工主键（针对一些渠道必须有人员才能获取session，否则不需要验证这个参数），建议不验证这个参数 |
FLASE |
| sign |
String |
基于双方线下约定的signKey生成的加密串，signKey是不参与接口传递的，基于MD5算法加密后，双方可以基于MD5不可被逆向解密的特性，确认对方有正确的signKey且传递的参数没有被参考。生成逻辑和示例代码 |
是 |
返回参数
| 字段 |
类型 |
释义 |
必填 |
| resCode |
String |
代码 |
是 |
| resMsg |
String |
错误描述，正确用success |
是 |
| sessionId |
String |
签名,代码不为“10000”时，这个可以为空 |
FLASE |
| timeLimit |
long |
有效期至，13位时间戳，代码不为“10000”时，这个可以为空 |
FLASE |
请求参数示例
{
"account": "exampleAccount",
"secret": "examplePassword",
"timestamp": 1618708800000,
"platform": "examplePlatform",
"source": "exampleSource",
"userId": 12345,
"userNo": "exampleUserNo",
"sign": "exampleSign"
}
返回参数示例
{
"resCode": "10000",
"resMsg": "success",
"sessionId": "exampleSessionId",
"timeLimit": 1622505600000
}
版本说明
| 版本号 |
编写日期 |
更改内容 |
| V1.0 |
2020.02.01 |
初稿 |
| V1.1 |
2023.06.01 |
减少一个userId，增加一个userNo |
| V1.2 |
2024.07.25 |
优化代码描述，优化请求示例和返回示例，增加soure字段，为未来去platform做准备 |