霜蝉云 接口使用说明 版本 :V1.00 上海霜蝉信息科技有限公司 Shanghai Scicala Information Technology Co.,Ltd http:www.scicala.com E-mail:support@scicala.com 1
目录目录... 2 一 产品概述...3 二 接口功能...3 三 调用规范...3 四 接口方法...4 1. 用户订阅 Subscribe (uname,upassword)... 4 2. 取消订阅 UnSubscribe(uname,key)...4 3. 绑定设备 DBind(deviceid, authcode,key)... 5 4. 解绑设备 UnDBind(deviceid,,key)... 5 5. 获取设备状态 GetDevList (deviceid,key)...6 6. 发送数据 AppSend(deviceid,key, message)...6 7. 接收数据 ReceiveMessage...7 8. 用户注册 UseRegist (email, password, key)...7 免责申明和版权公告 本文中的信息, 包括供参考的 URL 地址, 如有变更, 恕不另行通知 本文档 按现状 提供, 不负任何担保责任, 包括对适销性 适用于特定用途或非侵权性的任何担保, 和任何提供 规格或样品在他处提到的任何担保 本文档不负任何责任, 包括使用本文档内信息产生的侵犯任何专利权行为的责任 本文档在此未以禁止发言或其他方式授权任何知识产权使用许可, 不管是明示许可还是暗示许可 文中提到的所有商标名称 商标和注册商标均属其各自所有者的财产, 特此声明 版权归 @2017 上海霜蝉信息科技有限公司所有 保留所有权利 2
一 产品概述 SCloudAPI 接口 ( 简称 SCA 接口 ) 是 霜蝉云面向设备厂商 开发者, 解决设备与上位机 (Android IOS PC) 之间相互通信, 提供数据服务的载体 二 接口功能 该接口主要包括用户订阅 取消订阅 绑定设备 设备解绑 获取设备状态 发送数据 接收数据 注册用户等功能 三 调用规范 规范用于指导三方合作伙伴正确调用接口进行数据传输 TCP 调用 URL:net.tcp:// cloud.scicala.com:10102/mex HTTP 调用 URL:http://cloud.scicala.com:10103/ SCloudAPI 数据返回 : json 3
四 接口方法 1. 用户订阅 Subscribe (uname,upassword) 创建连接, 申请控制密钥 输入参数 : 参数名称 参数含义 参数样例 uname 用户名 / 邮箱 Guest upassword 密码 123456 "action" : "ressubscribe ", "state" :"1", "identity":"71d029e8 0c67 407a af9f 63065d005808", // 身份 id "key":"0cc175b9c0f1b6a831c399e269772661" // 密钥 返回值 : 订阅状态 key( 密钥 ) 状态值状态信息 1 订阅成功 0 订阅失败 2. 取消订阅 UnSubscribe(identity,key) 断开连接输入参数 : identity string 身份 ID 71d029e8 0c67 407a af 9f 63065d005808 key string 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e269772661 "action" : " resunsubscribe ", "state":"1" 4
返回 : 状态状态值状态信息 1 取消订阅成功 0 取消订阅失败 3. 绑定设备 DBind(deviceid, authcode,key) deviceid string 设备 ID WES123456789ABCD authcode string 设备授权码 A1B1C1D1 key string 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e269772661 "action" : "resdbind", "state":"1", 返回 : 绑定状态状态值状态信息 1 设备绑定成功 0 设备绑定失败 1 设备绑定关系已存在 2 授权码错误 3 非法设备 4. 解绑设备 UnDBind(deviceid,,key) deviceid string 设备 ID WES123456789ABCD key string 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e269772661 "action" : "resundbind", " state":"1", 5
返回 : 解绑状态状态值状态信息 1 设备解绑成功 0 设备解绑失败 1 解绑设备不属于用户 2 解绑设备不存在 5. 获取设备状态 GetDevList (deviceid,key) 参数名称 参数含义 参数样例 deviceid 设备 ID WES123456789ABCD key 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a831c39 9e269772661 查询单个设备状态时, 填写需要查询的设备 ID, 查询所有设备, 设备 ID 不填 ; "action" : "resgetdevlist", " state":"1", "data" : "deviceid" : "WE8SAB1647003211", // 设备 ID "name" : "SC8201", // 设备名称 "state" : "1" // 设备状态, 状态值状态信息 1 获取设备成功 0 获取设备失败 6. 发送数据 AppSend(deviceid,key, message) deviceid string 设备 ID WES123456789ABCD key string 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e269772661 6
message string 消息数据 scicala cloud "action" : "resappsend", state : "1 ", 7. 接收数据 ReceiveMessage 实现回调函数 ReceiveMessage 接收设备发来的数据 "did" : "WE8SAB1647000001", "action" : "resdevsend", "data": "31 32 33 34 35 36 37 38 39", state : "1 ", // 设备 id // 消息 / / 状态 8. 用户注册 UseRegist (email, password, key) email string 邮箱 Xiaoxi@qq.com password string 密码 123456 key string 密钥 ( 由订阅产生的 private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a 831c399e2697726 61 "action" : "resuseregist", "state":"1" 7
返回 : 注册状态状态值状态信息 1 注册成功 0 注册失败 1 邮箱已被注册 2 错误的邮箱 公司 : 上海霜蝉信息科技有限公司 网址 :www.scicala.com 技术支持 :support@scicala.com 8