会话管理

会话登录

http 请求方式:POST(请使用 https 协议)https://clb.kdware.cn:5000/v1.1/login

功能简介:该调用用于根据调用的用户名和密码登陆系统,获取会话凭证(sessionid),本接口的任何其它调用都需要使用该凭证。

请求示例

参数说明

{
"name": "09000001",
"passwd": "88888888"
}
参数类型可选说明
namestring必须登录的用户名
passwdstring必须登录的密码

返回结果

正确时的返回 JSON 数据包如下:

{
"resultCode": 0,
"sessionid": "3c441963-88ba-4b2d-876f-d6d98d72d2d6"
}
参数类型说明
resultCodenumber0 为成功,其它值为失败
sessionidstring会话凭证,用于后续调用识别用户身份

会话注销

http 请求方式:POST(请使用 https 协议)https://clb.kdware.cn:5000/v1.1/logout

功能简介:当用户做完操作后,请调用注销接口,释放服务器对会话的占用。

请求示例

参数说明

{
"sessionid": "8c09487e-320a-4e19-b89a-4a7ba00f24e0"
}
参数类型可选说明
sessionidstring必须会话凭证

返回结果

正确时的返回 JSON 数据包如下:

{
"resultCode": 0
}
参数类型说明
resultCodenumber0 为成功,其它值为失败

会话保持

http 请求方式:POST(请使用 https 协议)https://clb.kdware.cn:5000/v1.1/keep

功能简介:本系统对于在 15 分钟内无任何操作的会话将进行自动注销清理,如在无任何其它调用操作的时候仍需要保持会话(通常用于保持使用 websocket 方式的事件监听连接),请在 15 分钟内调用一次 keep 操作(注意:调用频率至少需要大于 5 分钟,小于 15 分钟,太快或太慢都会触发后台强制注销该会话)。

请求示例

参数说明

{
"sessionid": "8c09487e-320a-4e19-b89a-4a7ba00f24e0"
}
参数类型可选说明
sessionidstring必须会话凭证

返回结果

正确时的返回 JSON 数据包如下:

{
"resultCode": 0
}
参数类型说明
resultCodenumber0 为成功,其它值为失败,当 keep 操作失败时,请重新调用 login 获得新的会话凭证,并使用新凭证完成后续操作