ISMS-OpenAPI系列-HTTP接口使用手册.pdf

上传人:py 文档编号:17849 上传时间:2021-08-11 格式:PDF 页数:290 大小:11.89MB
返回 下载 相关 举报
ISMS-OpenAPI系列-HTTP接口使用手册.pdf_第1页
第1页 / 共290页
ISMS-OpenAPI系列-HTTP接口使用手册.pdf_第2页
第2页 / 共290页
ISMS-OpenAPI系列-HTTP接口使用手册.pdf_第3页
第3页 / 共290页
ISMS-OpenAPI系列-HTTP接口使用手册.pdf_第4页
第4页 / 共290页
ISMS-OpenAPI系列-HTTP接口使用手册.pdf_第5页
第5页 / 共290页
亲,该文档总共290页,到这儿已超出免费预览范围,如果喜欢就下载吧!
资源描述

《ISMS-OpenAPI系列-HTTP接口使用手册.pdf》由会员分享,可在线阅读,更多相关《ISMS-OpenAPI系列-HTTP接口使用手册.pdf(290页珍藏版)》请在文字多文库上搜索。

1、 使用手册使用手册 杭 州 海 康 威 视 系 统 技 术 有 限 公 司 文档编号 ISMS-OpenAPI 系列 - HTTP 接口使用手册 编制 审批 杭州海康威视系统技术有限公司 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 第 2 页 目目 录录 目目 录录 . 2 1. 开发前必读开发前必读 . 5 1.1 修订记录 . 5 1.2 概述 . 6 1.3 错误码说明 . 6 1.4 接口认证方式 . 7 1.5 接口版本说明 . 7 2. 开始开发开始开发 . 7 2.1 获取 AppKey 和 Secret . 7 2.2 生成 token 值.

2、7 2.3 发起请求 . 9 2.4 常见问题 . 9 3. 基础应用基础应用 . 10 3.1 基础应用资源获取 . 10 3.2 用户管理 . 14 3.3 组织管理 . 23 3.4 网域应用 . 32 3.5 服务器 . 34 3.6 部门管理 . 35 3.7 人员管理 . 42 3.8 卡片管理 . 55 4. 视频应用视频应用 . 63 4.1 视频资源获取 . 63 4.2 视频预览 . 89 4.3 录像回放 . 94 4.4 抓图 . 98 4.5 录像 . 99 4.6 客流量查询 . 102 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开

3、2017-07-17 第 3 页 4.7 热度数据获取 . 113 4.8 预置点 . 115 5. 停车场应用停车场应用 . 119 5.1 接口调用流程图 . 119 5.2 停车场资源获取 . 121 5.3 设备控制 . 132 5.4 记录查询 . 134 5.5 缴费 . 160 5.6 固定车管理 . 169 5.7 寻车 . 177 5.8 车位状态 . 183 5.9 车位预约 . 188 5.10 布控管理 . 191 6. 门禁应用门禁应用 . 198 6.1 接口调用流程图 . 198 6.2 门禁资源获取 . 199 6.3 门禁分组 . 212 6.4 计划模板获取

4、 . 215 6.5 门禁点状态获取 . 221 6.6 门禁权限配置 . 223 6.7 门禁点控制 . 230 6.8 门禁点历史事件获取 . 233 7. 事件订阅事件订阅 . 237 8. 附录附录 . 242 8.1 基础应用 . 242 8.2 视频 . 246 8.3 停车场 . 251 8.4 门禁 . 257 8.5 事件订阅 . 263 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 4 页 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 5 页 1. 开发前必读

5、开发前必读 1.1 修订记录修订记录 序号序号 变更时间变更时间 版本版本 变更人变更人 审批人审批人 变更说明变更说明 1 2016/11/17 V0.1 庞代强 周萍 创建文档。 2 2016/11/21 V0.2 吴元腾 1、细化生成 2.2token 值过程。 2、 在 2.4 常见问题说明中添加接口请 求返回 404 错误问题描述。 3、添加 3.2 获取组织异步树相关接 口。 4、添加根据设备或监控点名称获取 设备或监控点信息接口。 3 2016/12/08 V0.3 庞代强 1、添加获取默认用户 UUID 接口。 2、修改 pageNo、pageSize 的数据类 型为 Inte

6、ger; 修改用户相关接口中的 失效时间类型为 YYYYMMDD。 3、对文档中接口的描述进行了修改, 使用更加明确。 4、修改接口适用范围为综合安防管 理平台。 4 2016/12/17 V0.4 周萍 1、修改“视频资源获取”中获取编 码设备的 4 个接口,增加返回值字段 smartType、smartSupport,修改对应 的返回值样例。 2、在附录中新增“智能码类型”字 段对照表|。 3、修改 planType 的类型描述。 4、修改 encoderModel、smartType、d evType 的类型描述。 5、调整编码设备接口的返回值的字 段排序,使符合用户的阅读习惯。 5 2

7、017/04/01 V0.5 许芳杰 1、统一全文字体。 2、添加停车场,门禁,访客,可视 对讲,考勤,入侵报警,巡查,梯控 子系统接口。 3、增加各个子系统的接口调用流程 图。 4、将枚举字段已超链接形式放置目 录后,使文档更规范。 5、调整各个接口的字段名称,接口 名称,出参顺序,统一全文公有字段 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 6 页 参数名称,更符合用户的阅读习惯。 6 2017/4/25 V0.6 周萍 1、新增基础应用:部门、人员、卡 片接口、视频接口。 2、修改门禁接口:根据 87 平台的功 能,修改门禁资源

8、模块的查询条件和 返回值;统一所有门禁接口关联的返 回值字段;根据平台的查询条件完善 门禁分组、计划模板和门禁权限配置 的字段信息; 3、修改章节 2.2:生成 token 值;结 合现场问题,修改生成 token 值的样 例说明,方便用户做二次开发。 1.2 概述概述 本文档主要描述综合安防管理平台 SDK(HTTP-API)提供给第三方数据交互的接口使用 手册,具体包括认证方式、接入过程、常见问题以及基础应用与视频应用等内容。 针对当前市场许多第三方应用对整合综合安防管理平台的服务与资源的迫切需求,综合 安防管理平台急需提供一套供第三方应用接入平台的 SDK。 1.3 错误码说明错误码说明

9、 接口被调用后,会返回错误码和具体错误信息。 错误码错误码 含义说明含义说明 0 接口调用成功,并正常返回 1000 系统异常 1001 API 参数无效 1002 appkey 无效 1003 time 时间戳无效 1004 token 无效 1005 平台服务异常 1006 API 接口异常 1007 版本不兼容 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 7 页 1.4 接口认证方式接口认证方式 调用方调用方首先要向平台管理员获取 appkey 和 secret; appkey:调用方唯一标识,方便 HTTP-API 统计与维护

10、; secret:密钥,用于生成 HTTP-API 校验所需的 token 值; 调用方调用方每次请求都需要带上当前时间戳参数 time,这里的时间戳是指 UTC 时间 1970 年 01 月 01 日 00 时 00 分 00 秒(北京时间 1970 年 01 月 01 日 08 时 00 分 00 秒)起至现在的总总 毫秒数毫秒数。服务端需要校验请求的时效性(服务服务端只处理有效时间范围内的请求,有效时间默端只处理有效时间范围内的请求,有效时间默 认为认为 5 分钟分钟) ; 调用方调用方遵照 HTTP-OpenAPI 约定规则生成 token,并作为接口调用的请求参数传入服务服务 端端进

11、行校验; 服务服务端端对调用方调用方传入的 token 参数值进行验证; 1.5 接口版本说明接口版本说明 接口标题后面的“ 【V2.X】 ”表示接口适用的综合安防管理平台版本。 如 3.1.1 添加用户【V2.7】表示该接口适用于综合安防管理平台 V2.7 及以上版本。 2. 开始开发开始开发 2.1 获取获取 AppKey 和和 Secret AppKey:调用方唯一标识,方便 HTTP-OpenAPI 统计与维护 Secret:密钥,用于生成 HTTP-OpenAPI 校验的 token 值 AppKey 和 Secret 有两种方式获取: 1.由管理员在平台配置生成,调用方需要与平台管

12、理员联系获取 AppKey 和 Secret。 2.开放数据库,由事业部进行生成维护 AppKey 和 Secret,详见获取 AppKey。 2.2 生成生成 token 值值 Token 值是将请求源串以及 Secret 通过 MD5 算法生成的,用来提高传输过程参数的防 篡改性。 token 值的生成共有 2 个步骤:构造源串构造源串,生成生成 token 值值。详见下面的描述。 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 第 8 页 Step1.构造源串构造源串 a.获取要请求 URI(统一资源标识符,即域名后面的地址串,示例:/openapi/ser

13、v ice/vss/preview/getPreviewParamByCameraUuid) ; b.将输入参数(系统参数和业务参数)生成 JSON 串; c.将 a 中 URI 和 b 中得到的字符串和 secrect 拼接起来得到源串。 源串构造示例 1.原始请求信息: screct:aa7aa8a8fa604c60866413f52563b70c HTTP 请求方式:POST 请求的 URI 路径(不含 HOST):/openapi/service/vss/preview/getPreviewParamByCameraUuid 请求参数: appkey: 61fdb13b, time:

14、1479364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f, cameraUuid: b785bcf358154a4594651b4b21ddd0af, netZoneUuid: 11d0e493870d40f9b2589383cf73001f 2. 构造源串: a.获取要请求的 URI:/openapi/service/vss/preview/getPreviewParamByCameraUuid b.将输入参数(系统参数和业务参数)生成 JSON 串:appkey:24982ba6,time:1479364577369,opUse

15、rUuid:4 3a9a55f76474bde89ecabc1d6914a7f,cameraUuid:b785bcf358154a4594651b4b21ddd0af,netZoneUuid:11d0e4938 70d40f9b2589383cf73001f c.将前两步中得到的字符串和 secrect 拼接起来得到源串(请求 URI+参数串+secret):“/openapi/service/vss/preview /getPreviewParamByCameraUuidappkey:24982ba6,time:1479364577369,opUserUuid:43a9a55f76474bd

16、e89ecab c1d6914a7f,cameraUuid:b785bcf358154a4594651b4b21ddd0af,netZoneUuid:11d0e493870d40f9b2589383cf7300 1faa7aa8a8fa604c60866413f52563b70c” 注:生成 token 的请求参数顺序与请求 URL 中的参数顺序保持一致 Step2.生成生成 token 值值 使用 MD5 算法对 Step1 中得到的源串进行运算,得到 token 值(大写) : ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 9 页

17、MD5(/openapi/service/vss/preview/getPreviewParamByCameraUuidappkey:24982ba6,time:1479364577369, opUserUuid:43a9a55f76474bde89ecabc1d6914a7f,cameraUuid:b785bcf358154a4594651b4b21ddd0af,netZoneUu id:11d0e493870d40f9b2589383cf73001faa7aa8a8fa604c60866413f52563b70c) token 值:5067D805D98456393A1C5DFE849B8

18、83B 注:每次请求都重新生成 token 值 token 值为 32 位长度的大写字符串 2.3 发起请求发起请求 Step1.将将 token 参数和值拼接到参数和值拼接到 POST 请求请求 URL 后面后面 http:/IP:PORT/openapi/service/base/user/getPreviewParamByCameraUuid?token=5067D805D98456393A1C5DFE84 9B883B 注:不要把 token 参数和值拼接到 POST 数据的 JSON 串上 Step2.发起请求发起请求 填写入参 appkey: 61fdb13b, time: 147

19、9364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f, cameraUuid: b785bcf358154a4594651b4b21ddd0af, netZoneUuid: 11d0e493870d40f9b2589383cf73001f Step3.接收返回报文接收返回报文 注:接口请求超时时间为 20S,用户无法进行重新配置 2.4 常见问题常见问题 2.4.1 接口请求返回接口请求返回 404 错误错误 HTTP-API 是独立的服务,有自己的 war 包和补丁,需要部署到综合安防管理平台所在 Tomcat 下并重启。 可能的情

20、况如下: ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 10 页 情况 1:HTTP-API 服务未部署或部署失败 在浏览器中请求 http:/IP:PORT/webapi 出现 hello world 页面,说明部署成功 出现 404 或者其他页面,说明未部署或部署失败,请根据部署文档重新部署 情况 2:请求 URL 错误 确认请求 URL 是否正确 2.4.2 appkey 无效无效 AppKey 和 Secret 是在综合安防管理平台维护的,请跟综合安防管理平台管理员确认 AppKey 和 Screct 是否有效。平台生成的 Ap

21、pKey 和 Secret 分别是 8 位和 32 位的字段串, 在使用前请核对准确。 2.4.3 时间戳无效时间戳无效 调用方在发起请求后, HTTP-API 服务会对请求入参中的时间戳进行校验, 如果调用方传 入的时间戳与 HTTP-API 服务的系统时间相差超过限制(默认 5 分钟,可以配置) ,则请求无 效,并返回对应的错误码。 可能的情况如下: 情况 1:时间戳单位不对 时间戳为 UTC 时间,以毫秒为单位 情况 2:调用方和 HTTP-API 服务的时差超过限制 调整调用方时间,使其与 HTTP-API 服务的时间同步 修改限制时间配置 2.4.4 token 无效无效 调用方在发

22、起请求后,openapi 根据请求的 URI、请求参数串以及从数据库中获取的 AppKey 对应的 Secret 生成 token 与请求带过来的 token 进行比较, 如果不同就会报 token 无效的错误。 在调用的时候计算的 token 需要注意请求的 URI 是否设置正确, 以及与 AppKey 匹配的 Secret 是否和数据库匹配,请核对好这些信息,参考 token 生成步骤进行计算。 3. 基础应用基础应用 3.1 基础应用资源获取基础应用资源获取 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 11 页 3.1.1 获取

23、子系统【获取子系统【V2.8.2】 应用场景 调用方可以根据该接口获取平台所有子系统 UUID 信息。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/res/getPlatSubsytem 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 appkey 调用方唯一标识 String 是 time 时间戳 Long 是 时间戳详见接口认证方式 token 认证参数 String 是 拼接在 POST 请求 URL 后面, token 生成见生成 token 值 接口参数 opUs

24、erUuid 操作用户 UUID String 是 入参举例如下: appkey: 61fdb13b, time: 1479364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f 返回参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回数据 List 是 data 主要属性: 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 ISMS-OpenAPI 系列

25、-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 12 页 subSystemUui d 子系统 UUID String 是 subSystemNam e 子系统名称 String 是 返回值样例如下: errorCode: 0, errorMessage: null, data: subSystemUuid: 1048576, subSystemName: 基础应用 , subSystemUuid: 2097152, subSystemName: 视频 , subSystemUuid: 25165824, subSystemName: 人脸 , subSystemUu

26、id: 26214400, subSystemName: 客流 , subSystemUuid: 27262976, subSystemName: 热度 , subSystemUuid: 28311552, subSystemName: 卡口 , subSystemUuid: 3145728, subSystemName: 门禁 , subSystemUuid: 5242880, subSystemName: 入侵报警 , subSystemUuid: 6291456, subSystemName: 停车场 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017

27、-07-17 第 13 页 , subSystemUuid: 9437184, subSystemName: 可视对讲 , subSystemUuid: 11534336, subSystemName: 考勤 , subSystemUuid: 10485760, subSystemName: 访客 , subSystemUuid: 4194304, subSystemName: 巡查 , subSystemUuid: 8388608, subSystemName: 消费 , subSystemUuid: 29360128, subSystemName: 车底检测 , subSystemUuid

28、: 7340032, subSystemName: 梯控 , subSystemUuid: 20971520, subSystemName: 动环 , subSystemUuid: 14680064, subSystemName: 电子地图 , subSystemUuid: 12582912, subSystemName: 事件中心 , subSystemUuid: 13631488, subSystemName: 运维管理 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 14 页 3.2 用户管理用户管理 3.2.1 添加用户【添加用户

29、【V2.7】 应用场景 需要主动向平台添加用户,或者是调用方希望同步数据,将用户数据推送到平台进行存 储可以调用该接口完成相应的功能。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/user/addUser 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 appkey 调用方唯一标识 String 是 time 时间戳 Long 是 时间戳详见接口认证方式 token 认证参数 String 是 拼接在 POST 请求 URL 后面, token 生成见生成 token 值

30、接口参数 opUserUuid 操作用户 UUID String 是 userUuid 用户 UUID String 否 loginAccount 用户登录名 String 是 userName 用户姓名 String 是 phoneNo 联系电话 String 否 email 邮箱 String 否 level 用户级别 Integer 否 默认 50 locked 锁定状态 Integer 否 详见锁定状态 endTime 失效日期 Long 否 精确到天,如 20161201 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 15 页

31、 createTime 创建时间 Long 否 时间戳,如果是同步数据想要保证 源数据可以加上,新增数据不要添 加该字段 updateTime 更新时间 Long 否 单位:毫秒 remark 备注 String 否 ipStart IP 区间开始 String 否 ipEnd IP 区间结束 String 否 入参举例如下: appkey: 61fdb13b, time: 1479364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f, loginAccount: test, userName: 测试 返回参数 属性名称属性名称 属性描

32、述属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回数据 Map 是 data 主要属性: 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 userUuid 用户 UUID String 是 loginAccount 用户登录名 String 是 userName 用户姓名 String 是 phoneNo 联系电话 String 否 email 邮箱 String 否 level 用户级别 Integer 否 默认 50 locked

33、锁定状态 Integer 否 详见锁定状态 endTime 失效日期 Long 否 精确到天,如 20161201 createTime 创建时间 Long 是 单位:毫秒 updateTime 更新时间 Long 是 单位:毫秒 remark 备注 String 否 ipStart IP 区间开始 String 否 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 16 页 ipEnd IP 区间结束 String 否 返回值样例如下: errorCode: 0, errorMessage: null, data: userUuid: a

34、3d38e495ccc4144a90e6eea5dd2be20, loginAccount: test, userName: 测试, phoneNo: null, email: null, locked: 0, level: 50, endTime: 20161201, createTime: 1477904115163, updateTime: 1477904115163, remark: null, ipStart: 192.168.0.1, ipEnd: 192.168.0.100 3.2.2 修改用户【修改用户【V2.7】 应用场景 该接口用于对用户信息的修改,更新时间(updateT

35、ime)平台会生成,但是调用方可能 要求保留自己的原有数据,所以当更新时间为空时,平台会生成,不为空时会使用传入的更 新时间。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/user/modifyUser 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 17 页 appkey 调用方唯一标识 String 是 time 时间戳 Long 是 时间戳详见接口认证方式 toke

36、n 认证参数 String 是 拼接在 POST 请求 URL 后面, token 生成见生成 token 值 接口参数 opUserUuid 操作用户 UUID String 是 userUuid 用户 UUID String 是 loginAccount 用户登录名 String 是 userName 用户姓名 String 是 phoneNo 联系电话 String 否 email 邮箱 String 否 level 用户级别 Integer 否 默认 50 locked 锁定状态 Integer 否 详见锁定状态 endTime 失效日期 Long 否 精确到天,如 20161201

37、updateTime 更新时间 Long 否 单位:毫秒 remark 备注 String 否 ipStart IP 区间开始 String 否 ipEnd IP 区间结束 String 否 入参举例如下: appkey: 61fdb13b, time: 1479364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f, userUuid: a3d38e495ccc4144a90e6eea5dd2be20, loginAccount: test, userName: 测试, remark: 测试修改用户 返回参数 属性名称属性名称 属性描述

38、属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回数据 Map 是 data 主要属性: 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 18 页 userUuid 用户 UUID String 是 loginAccount 用户登录名 String 是 userName 用户姓名 String 是 phoneNo 联系电话 Strin

39、g 否 email 邮箱 String 否 level 用户级别 Integer 否 默认 50 locked 锁定状态 Integer 否 详见锁定状态 endTime 失效日期 Long 否 精确到天,如 20161201 createTime 创建时间 Long 是 单位:毫秒 updateTime 更新时间 Long 是 单位:毫秒 remark 备注 String 否 ipStart IP 区间开始 String 否 ipEnd IP 区间结束 String 否 返回值样例如下: errorCode: 0, errorMessage: null, data: userUuid: a3

40、d38e495ccc4144a90e6eea5dd2be20, loginAccount: test, userName: 测试, phoneNo: null, email: null, locked: 0, level: 50, endTime: 20161201, createTime: 1477904115163, updateTime: 1477904115163, remark: 测试修改用户, ipStart: 192.168.0.1, ipEnd: 192.168.0.100 3.2.3 删除用户【删除用户【V2.7】 应用场景 该接口用于删除用户数据,当用户的 UUID 存在时

41、能够正确删除,如果用户的 UUID 不存 在将视为删除成功。该接口支持批量删除用户数据,传入的参数是将要删除的多个用户的 ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 19 页 UUID 用“,”分割组成的字符串。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/user/deleteUsersByUuids 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 appkey 调用方唯一标识 String 是 time 时间戳

42、 Long 是 时间戳详见接口认证方式 token 认证参数 String 是 拼接在 POST 请求 URL 后面, token 生成见生成 token 值 接口参数 opUserUuid 操作用户 UUID String 是 userUuids 用户 UUID 集合 String 是 用“,”分割,建议 400,最大不超过 1000 入参举例如下: appkey: 61fdb13b, time: 1479364577369, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f, userUuid: a3d38e495ccc4144a90e6eea5dd

43、2be20,b93097b1d0fa4d27972ed15609554a5d 返回参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回数据 Object 是 返回值样例如下: errorCode: 0, errorMessage: null, ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 20 页 data: null 3.2.4 获取默认用户获取默认用户 UUID【V

44、2.7】 应用场景 该接口用于获取默认用户的 UUID,其他每个接口都需要操作用户的 UUID,通过该接口 获取默认用户的 UUID 后可以进行其他操作。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/user/getDefaultUserUuid 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 appkey 调用方唯一标识 String 是 time 时间戳 Long 是 时间戳详见接口认证方式 token 认证参数 String 是 拼接在 POST 请求 URL 后面,

45、 token 生成见生成 token 值 入参举例如下: appkey: 61fdb13b, time: 1479364577369, 返回参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回 UUID 数据 String 是 返回值样例如下: errorCode: 0, ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 21 页 errorMessage: null, d

46、ata: ef51b7a4bbaa11e6b086838b707212fa 3.2.5 分页获取用户【分页获取用户【V2.7】 应用场景 该接口用于分页获取用户信息,根据传入的当前页码,以及设定的分页的大小获取定量 的用户信息。 适用范围 综合安防管理平台 接口地址 http:/IP:PORT/openapi/service/base/user/getUsers 提交方式 POST 输入参数 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 系统参数 appkey 调用方唯一标识 String 是 time 时间戳 Long 是 时间戳详见接口认证方式 token 认证参数 S

47、tring 是 拼接在 POST 请求 URL 后面, token 生成见生成 token 值 接口参数 pageNo 当前页码 Integer 是 大于 0 pageSize 每页数据记录数 Integer 是 建议 400,不超过 1000 opUserUuid 操作用户 UUID String 是 入参举例如下: appkey: 61fdb13b, time: 1479364577369, pageNo: 1, pageSize: 10, opUserUuid: 43a9a55f76474bde89ecabc1d6914a7f 返回参数 ISMS-OpenAPI 系列-HTTP 接口使用

48、手册 密级级别: 外部公开 2017-07-17 第 22 页 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 errorCode 错误码 Integer 是 0 表示成功,其它详见错误码说明 errorMessage 错误消息 String 否 data 返回数据 Map 是 data 主要属性: 属性名称属性名称 属性描述属性描述 类型类型 必须必须 备注备注 total 查询数据记录总数 Integer 是 pageNo 当前页码 Integer 是 pageSize 每页记录总数 Integer 是 list 对象列表 List 否 list 主要属性: 属性名称属性

49、名称 属性描述属性描述 类型类型 必须必须 备注备注 userUuid 用户 UUID String 是 loginAccount 登录用户名 String 是 userName 用户姓名 String 是 phoneNo 联系电话 String 否 email 邮箱 String 否 level 用户级别 Integer 否 默认 50 locked 锁定状态 Integer 否 详见锁定状态 endTime 失效日期 Long 否 精确到天,如 20161201 createTime 创建时间 Long 是 单位:毫秒 updateTime 更新时间 Long 是 单位:毫秒 remark

50、 备注 String 否 ipStart IP 区间开始 String 否 ipEnd IP 区间结束 String 否 返回值样例如下: errorCode: 0, errorMessage: null, data: total: 2, pageNo: 1, pageSize: 10, ISMS-OpenAPI 系列-HTTP 接口使用手册 密级级别: 外部公开 2017-07-17 第 23 页 list: userUuid: a3d38e495ccc4144a90e6eea5dd2be20, loginAccount: admin, userName: 测试, phoneNo: 1334

展开阅读全文
相关资源
猜你喜欢
相关搜索

当前位置:首页 > 行业资料 >


一体机

文字多文库 在线文档分享平台

文字多文库网站 版权所有 

蜀ICP备2022017241号 

川公网安备 51010702002281号

互联网违法和不良信息举报   邮箱:wzdwk@wzdwk.com