三友对接文档.pdfVIP

目 录 修改记录 前言 API使用场景 重要约定 V2.0 API规范 接口约定 语法 网络通信方式 API接口鉴权说明 接口鉴权规范 API接口列表 API接口详解 三友平台提供接口 增加设备 查询设备状态 删除设备 查询设备上下线 控制设备 中物物联提供接口 数据上报 事件上报 功能上报 查询出入库单号信息 API错误码 中物物联错误码 三友错误码 数据类型 数据加密 事件类型 双方技术对接相关问题讨论 （待完善 ） 设备添加与区分 本文档使用 看云 构建 - 2 - 修改记录 修改记录 修改日期 修改内容 2017-07-10 删除单独的鉴权接口 ，token没有有效期 2017-09-25 添加功能配置成功事件 ，功能配置失败事件 2017-11-20 添加事件msg字段 ，用于辅助说明事件的详细信息 2018-01-15 API版本升级为2.0 2018-03-14 增加上下线查询接口 本文档使用 看云 构建 - 3 - 前言 前言 当三友平台需要通过API方式与中物物联网平台进行对接时，API对接必须遵循本文档。 本文档使用 看云 构建 - 4 - API使用场景 API使用场景 用户使用中物物联的APP （以下简称APP ）管理其所购买设备(该设备可通过三友平台进行管理 ）。 APP直连中物物联PaaS平台 ，用户对设备的操作均通过APP发送到中物物联PaaS平台 ，中物物联PaaS 平台解析用户的操作请求后发送到三友平台相应的API接口进行处理。 一般情况下 ，设备的功能配置等操作只能通过APP ，当设备因为非APP操作导致的设备功能的变更时 (如设备具有智能处理功能或用户手动操作等) ，三友平台需要通过中物提供的接口主动上报功能的变 更。 本文档使用 看云 构建 - 5 - 重要约定 重要约定 设备唯一标识唯一性 设备的唯一标识是双方平台区分设备的重要依据。与中物物联对接的三友平台必须确保其与中物对接 的所有类型设备的唯一标识不能重复。换句话说 ，同三友平台所管理的所有类型的设备不能存在重复 的设备唯一标识。 功能配置部分生效说明 配置三友平台下设备时 ，如果一次操作传输的配置功能有多个三友平台必须确保这次操作所配置的多 个功能要么全部成功 ，要么全部失败。 批量操作 当批量对设备进行功能配置时 ，三友平台先返回请求是否有效 。当检测到设备实际功能配置失败时 ， 三友平台需通过中物的功能变更上报接口推送信息到中物平台以同步双方对设备的配置信息。 本文档使用 看云 构建 - 6 - V2.0 V2.0 API规范 API接口鉴权说明 API接口列表 API接口详解 API错误码 数据类型 数据加密 事件类型 本文档使用 看云 构建 - 7