Microsoft Word - SC700003SS1-SCICALA霜蝉云接口使用说明V1.0.1_ docx

Size: px

Start display at page:

Download "Microsoft Word - SC700003SS1-SCICALA霜蝉云接口使用说明V1.0.1_ docx"

昭等项
4 years ago
Views:

1 SCICALA 霜蝉云接口使用说明版本 :V1.01 [No.SC700003SS1] 上海霜蝉信息科技有限公司 Shanghai Scicala Information Technology Co.,Ltd 网址 : support@scicala.com 电话 :

2 免责申明和版权公告本文中的信息, 包括供参考的 URL 地址, 如有变更, 恕不另行通知本文档按现状提供, 不负任何担保责任, 包括对适销性适用于特定用途或非侵权性的任何担保, 和任何提供规格或样品在他处提到的任何担保本文档不负任何责任, 包括使用本文档内信息产生的侵犯任何专利权行为的责任本文档在此未以禁止发言或其他方式授权任何知识产权使用许可, 不管是明示许可还是暗示许可文中提到的所有商标名称商标和注册商标均属其各自所有者的财产, 特此声明上海霜蝉信息科技有限公司所有保留所有权利 2

3 目录一产品概述... 4 二接口功能... 4 三调用规范... 4 四接口方法 TCP 方式调用说明用户订阅 Subscribe (uname,upassword) 取消订阅 UnSubscribe(identity,key) 绑定设备 DBind(deviceid, authcode,dname,compwd,key) 解绑设备 UnDBind(deviceid,key) 获取设备列表 GetDevList (deviceid,key) 更新设备信息 UpdateDevInfo (deviceid, dname, compwd,key) 发送数据 AppSend(deviceid, identity, key, message) 接收数据 ReceiveMessage() 用户注册 UseRegist ( , password, key) 查询设备状态 DevStatusQuery (deviceid, key) 查询设备信息 GetQueryInfo (deviceid, qtype, key) HTTP 方式调用说明用户订阅 Subscribe (uname,upassword) 取消订阅 UnSubscribe(identity,key) 绑定设备 DBind(deviceid, authcode,dname,compwd,key) 解绑设备 UnDBind(deviceid,key) 获取设备列表 GetDevList (identity,key) 更新设备信息 UpdateDevInfo (deviceid, dname, compwd,key) 发送数据 AppSend(deviceid, identity, key, message) 接收数据 ReceiveMessage(deviceid,key) 用户注册 UseRegist ( , password, key) 查询设备状态 DevStatusQuery (deviceid, key)

4 一产品概述 SCloudAPI 接口 ( 简称 SCA 接口 ) 是 SCICALA 霜蝉云面向设备厂商开发者, 解决设备与上位机 (Android IOS PC) 之间相互通信, 提供数据服务的载体二接口功能该接口主要包括用户订阅取消订阅绑定设备设备解绑编辑设备信息, 获取设备状态发送数据接收数据注册用户查询设备信息等功能三调用规范规范用于指导三方合作伙伴正确调用接口进行数据传输 TCP 调用 URL:net.tcp:// cloud.scicala.com:10112/mex HTTP 调用 URL: SCloudAPI HTTPS 调用 URL: 数据返回 : json 4

5 四接口方法 4.1.TCP 方式调用说明用户订阅 Subscribe (uname,upassword) 创建连接, 申请控制密钥输入参数 : 参数名称参数含义参数样例 uname 用户名 / 邮箱 Guest upassword 密码 "action" : "ressubscribe ", "state" :"1", "identity":"71d029e8 0c67 407a af9f 63065d005808", "key":"0cc175b9c0f1b6a831c399e " // 身份 id // 密钥返回值 : 订阅状态 state key( 密钥 ) 1 订阅成功 0 订阅失败取消订阅 UnSubscribe(identity,key) 断开连接输入参数 : identity string 身份 ID 71d029e8 0c67 407aaf9f 63065d cc175b9c0f1b6a83 1c399e "action" : " resunsubscribe ", "state":"1" 5

6 返回 : 状态 state 1 取消订阅成功 0 取消订阅失败绑定设备 DBind(deviceid, authcode,dname,compwd,key) deviceid string 设备 ID WES ABCD authcode string 设备授权码 A1B1C1D1 dname string 设备名称自定义 compwd string 通信密码 (8 位通信密码 ) private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e "action" : "resdbind", "state":"1", 返回 : 绑定状态 state 1 设备绑定成功 0 设备绑定失败 1 设备绑定关系已存在 2 授权码错误 3 非法设备解绑设备 UnDBind(deviceid,key) deviceid string 设备 ID WES ABCD 0cc175b9c0f1b6a83 1c399e

7 "action" : "resundbind", " state":"1", 返回 : 解绑状态 state 1 设备解绑成功 0 设备解绑失败 1 解绑设备不属于用户 2 解绑设备不存在获取设备列表 GetDevList (deviceid,key) 参数名称参数含义参数样例 identity 身份 ID 71d029e8 0c67 407a af9f 63065d key 密钥 ( 由订阅产生的 0cc175b9c0f1b6a831c39 9e 查询单个设备状态时, 填写需要查询的设备 ID, 查询所有设备, 设备 ID 不填 ; "action":"resgetdevlist", " state":"1", "data" : "deviceid" : "WE8SAB ", // 设备 ID "name":"sc8201", // 设备名称 "state":"1" // 设备状态, 返回 : 状态 state 1 获取设备列表成功 0 获取设备列表失败更新设备信息 UpdateDevInfo (deviceid, dname, compwd,key) 参数名称参数含义参数样例 7

8 deviceid 设备 ID WES ABCD dname 设备名称自定义 compwd 通信密码 (8 位通信密码 ) key 密钥 ( 由订阅产生的 0cc175b9c0f1b6a831c39 9e 用于更改设备名称和通讯密码等信息, " action" : " resupdatedevinfo", "state":"1", 返回 : 更新状态 state 状态值状态信息 1 设备信息更新成功 0 设备信息更新失败 1 设备设备 ID 错误 2 密钥错误发送数据 AppSend(deviceid, identity, key, message) deviceid string 设备 ID WES ABCD identity string 身份 ID 71d029e8 0c67 407aaf9f 63065d private_key, 通过特殊 0cc175b9c0f1b6a83 1c399e 加密算法生成 ) message string 消息数据 scicala cloud "action" : "resappsend", state : "1 ", 返回 : 发送状态 state 1 发送成功 0 发送失败, 设备离线 8

9 接收数据 ReceiveMessage() 实现回调函数 ReceiveMessage 接收设备发来的数据, 接收查询设备信息返回的数据 "did" : "WE8SAB ", "action" : "resdevsend", "data": " ", state : "1 ", // 设备 id // 消息 / / 状态用户注册 UseRegist ( , password, key) string 邮箱 Xiaoxi@qq.com password string 密码 cc175b9c0f1b6a 831c399e "action" : "resuseregist", "state":"1" 返回 : 注册状态 state 1 注册成功 0 注册失败 1 邮箱已被注册 2 错误的邮箱查询设备状态 DevStatusQuery (deviceid, key) 参数名称参数类型参数含义参数样例 deviceid string 设备 Id WE8SAB

10 0cc175b9c0f1b6a 831c399e 可以用于查询设备串口信息电量等, 如果接了 GPS 还可以查询设备当前位置信息 "action" : "resdevstatusquery", " deviceid ":" WE8SAB ", // 设备 id " dstatus":1, // 设备状态 "state":"1", // 执行状态返回 : 查询状态 state 1 查询成功 0 查询失败 1 查询失败, 设备未绑定查询设备信息 GetQueryInfo (deviceid, qtype, key) deviceid string 设备 Id WE8SAB qtype int 查询信息类型如串口信息 :1 0cc175b9c0f1b6a 831c399e 可以用于查询设备串口信息电量等, 如果接了 GPS 还可以查询设备当前位置信息 "action" : "resquery", "state":"1" 返回 : 查询状态 state 1 查询成功 0 查询失败 10

11 1 查询失败, 设备未绑定 2 查询失败, 设备不存在 4.2.HTTP 方式调用说明用户订阅 Subscribe (uname,upassword) 创建连接, 申请控制密钥 URL: d=upassword HTTP 方法 :GET 输入参数 : 参数名称参数含义参数样例 uname 用户名 / 邮箱 Guest upassword 密码注意 : 身份 id 每次请求都会变, 密钥是不会变的 ( 每个用户只能申请一个密钥 ) "action" : "ressubscribe ", "state" :"1", "identity":"71d029e8 0c67 407a af9f 63065d005808", // 身份 id "key":"0cc175b9c0f1b6a831c399e " // 密钥返回值 : 订阅状态 state key( 密钥 ) 1 订阅成功 0 订阅失败取消订阅 UnSubscribe(identity,key) 断开连接 11

12 URL: =KEY HTTP 方法 :GET 输入参数 : identity string 身份 ID 71d029e8 0c67 407aaf9f 63065d cc175b9c0f1b6a83 1c399e "action" : " resunsubscribe ", "state":"1" 返回 : 状态 state 1 取消订阅成功 0 取消订阅失败绑定设备 DBind(deviceid, authcode,dname,compwd,key) 用于用户绑定设备 URL: =AUTHCODE&dname=DNAME&compwd=COMPWD&key=KEY HTTP 方法 :GET 输入参数 deviceid string 设备 ID WES ABCD authcode string 设备授权码 A1B1C1D1 dname string 设备名称自定义 compwd string 通信密码 (8 位通信密码 ) private_key, 通过特殊加密算法生成 ) 0cc175b9c0f1b6a83 1c399e

13 "action" : "resdbind", "state":"1", 返回 : 绑定状态 state 1 设备绑定成功 0 设备绑定失败 1 设备绑定关系已存在 2 授权码错误 3 非法设备解绑设备 UnDBind(deviceid,key) 用于解绑已绑定设备 URL: EY HTTP 方法 :GET 输入参数 deviceid string 设备 ID WES ABCD 0cc175b9c0f1b6a83 1c399e "action" : "resundbind", " state":"1", 返回 : 解绑状态 state 1 设备解绑成功 0 设备解绑失败 1 解绑设备不属于用户 2 解绑设备不存在 13

14 获取设备列表 GetDevList (identity,key) 用于获取用户绑定的设备列表 URL: KEY HTTP 方法 :GET 输入参数参数名称参数含义参数样例 identity 身份 ID 71d029e8 0c67 407a af9f 63065d key 密钥 ( 由订阅产生的 0cc175b9c0f1b6a831c39 9e 查询单个设备状态时, 填写需要查询的设备 ID, 查询所有设备, 设备 ID 不填 ; "action":"resgetdevlist", " state":"1", "data" : "deviceid" : "WE8SAB ", // 设备 ID "name":"sc8201", // 设备名称 "state":"1", // 设备状态 0: 离线,1: 在线 "compwd":" " // 设备通讯密码, 返回 : 状态 state 1 获取设备列表成功 0 获取设备列表失败更新设备信息 UpdateDevInfo (deviceid, dname, compwd,key) 用户修改设备名称, 通讯密码等信息 URL: newname=newname&commpwd=commpwd&key=key HTTP 方法 :GET 14

15 输入参数参数名称参数含义参数样例 deviceid 设备 ID WES ABCD newname 设备名称自定义 commpwd 通信密码 (8 位通信密码 ) key 密钥 ( 由订阅产生的 0cc175b9c0f1b6a831c39 9e " action" : " resupdatedevinfo", "state":"1", 返回 : 更新状态 state 1 设备信息更新成功 0 设备信息更新失败 1 设备设备 ID 错误 2 密钥错误发送数据 AppSend(deviceid, identity, key, message) 用于给设备发送数据 URL: HTTP 方法 :POST 注意 :Content-Type: application/json 示例 deviceid : WES ABCD, identity : 订阅时返回的身份 id, key : 订阅时返回的 key 值信息, message : 您要发送的数据输入参数 deviceid string 设备 ID WES ABCD identity string 身份 ID 71d029e8 0c67 407aaf9f 63065d private_key, 通过特殊 0cc175b9c0f1b6a83 1c399e 加密算法生成 ) message string 消息数据 scicala cloud message 为 16 进制数据时以十六进制发送为非十六进制时以字符串发送 15

16 "action" : "resappsend", state : "1 ", 返回 : 发送状态 state 1 发送成功 0 发送失败, 设备离线接收数据 ReceiveMessage(deviceid,key) 用于获取设备回传的数据 URL: &key=key HTTP 方法 :GET 输入参数 deviceid string 设备 ID WES ABCD 0cc175b9c0f1b6a83 1c399e "did" : "WE8SAB ", "action" : "resdevsend", "data": " ", state : "1 ", // 设备 id // 消息 / / 状态用户注册 UseRegist ( , password, key) 通过接口注册用户 URL: HTTP 方法 :POST 注意 :Content-Type: application/json 16

17 示例 xxxx@qq.com, password : , key : 订阅时返回的 key 值信息输入参数 string 邮箱 Xiaoxi@qq.com password string 密码 cc175b9c0f1b6a 831c399e "action" : "resuseregist", "state":"1" 返回 : 注册状态 state 1 注册成功 0 注册失败 1 邮箱已被注册 2 错误的邮箱查询设备状态 DevStatusQuery (deviceid, key) 用于查询设备是否在线 URL: &key=key HTTP 方法 :GET 输入参数 deviceid string 设备 Id WE8SAB cc175b9c0f1b6a 831c399e 可以用于查询设备串口信息电量等, 如果接了 GPS 还可以查询设备当前位置信息 17

18 "action" : "resdevstatusquery", " deviceid ":" WE8SAB ", // 设备 id " dstatus":1, // 设备状态 0: 离线,1: 在线 "state":"1", // 执行状态返回 : 查询状态 state 1 查询成功 0 查询失败 1 查询失败, 设备未绑定 18

<453A5CCEC4B5B55C C41CBAAB2F5D4C6BDD3BFDACAB9D3C3CBB5C3F756312E305F E646F63>

<453A5CCEC4B5B55C C41CBAAB2F5D4C6BDD3BFDACAB9D3C3CBB5C3F756312E305F E646F63> 霜蝉云接口使用说明版本 :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