超级文档
SDK说明
登录
免费注册 / 登录

SDK说明

编写人:刘洋
名称:协同预订 SDK
版本:0.3.0
日期:0000-00-00
状态:预发可用

一、用途

协同预订 SDK 给总部会议室门口的显示屏使用,用来读取某一间房今天的占用。显示屏不走员工网页。SDK 目前只有 Java 一种,版本 0.3.0,运行在 Java 17。调用方凭显示屏账号取令牌,令牌 2 小时有效。生产尚未发给全部 12 间屏,预发接了 3 楼第一会议室的样机。张伟批准样机稳定一周后再扩到其余房间。

二、提供的方法

主题最长显示 20 个字,超出部分由屏上省略。日期使用东八区的日历日。listToday 在预发 3 楼第一会议室返回 9月19日的 4 段占用,与网页一致。

三、调用约定

  1. 服务地址在预发是屏内配置的内网域名,生产地址由周敏在装屏时写入,不写进 SDK 包。
  2. 令牌放在请求头。过期后 SDK 自动换一次,仍失败则屏上显示「请联系前台」。
  3. 超时 2 秒。超时后屏保留上一次成功的列表,并标出获取时间。
  4. 房间编号使用 R-3-01 这种格式,与网页里的 12 间会议室相同。

四、错误与限制

房间不存在时返回业务码 40410,屏上显示房间编号。令牌无效返回 40001。单屏每分钟最多调 30 次,超过后返回 40009,SDK 退回到 1 分钟前的缓存。0.3.0 不能创建预订,创建仍在网页完成。王芳用样机连续看了 2 小时,列表与网页差 0 段。下一版 0.4.0 才考虑刷新频率配置,本版固定 60 秒刷新一次。样机在 9月19日 14:00 至 16:00 刷新了 120 次,失败 0 次,屏上主题与网页 4 段占用一致。周敏计划 9月26日再接 3 楼第二间,仍用 0.3.0,房间编号 R-3-02。两间样机都只读当天占用,不能在屏上改期。若 0.3.0 连续 7 天失败为 0,张伟再批其余 10 间,安装人仍是周敏。