使用流程
第一步：创建我的应用
为了正常运行开发环境，您需要建立一个应用并获得相应的【应用标识】、【应用安全密钥】和【应用服务器地址】，具体步骤如下：
1.点击进入飞天智能物联平台登录页面，登录飞天智能物联平台。
2.在管理平台左侧列表中，点击【添加应用】，跳转至添加应用界面，进行应用添加。
3.输入【应用名称】，应用描述（可选），点击【保存】按钮后，页面跳转至应用列表可查看新添加应用的【应用标识】【应用安全密钥】【应用服务器地址】等关键信息，在API初始化时需要用到这些参数。
第二步：下载 Java SDK，请点击下面下载图标：
第三步：初始化
请求接口：public static void init(String serverUrl, String appKey, String appSecret)
接口功能：无论您使用哪种语言与飞天IoTAPI进行集成，首先都需要调用API中的初始化接口。此接口只需调用一次。
| 参数名 | 参数说明 |
|---|---|
| serverUrl | 应用服务地址 |
| appKey | 应用标识 |
| appSecret | 应用安全密钥 |
| 参数名 | 参数说明 |
|---|---|
| 无 | 无 |
第四步：集成您需要的接口
初始化完成之后，您可以根据您的业务需要进行接口集成，请参见SDK接口详细介绍
SDK初始化
请求接口： public static void init(String serverUrl, String appKey, String appSecret)
接口功能：无论您使用哪种语言与飞天IoTAPI进行集成，首先都需要调用API中的初始化接口。此接口只需调用一次。
| 参数名 | 参数说明 |
|---|---|
| serverUrl | 应用服务地址 |
| appKey | 应用标识 |
| appSecret | 应用安全密钥 |
| 参数名 | 参数说明 |
|---|---|
| 无 | 无 |
设备绑定
请求接口： public static string bindDevice(String deviceSN, String payCode)
接口功能：将终端设备和商户二维码牌进行绑定。上传设备编号、二维码牌标识推送给消息服务平台，验证通过后，将此设备和码牌进行绑定。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号 |
| payCode | 收钱码（收钱码的二维码内容，或唯一标识） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应参数的签名 |
获取码牌绑定设备
请求接口： public static String getBindDevice(String payCode)
接口功能：获取码牌绑定的设备信息。
| 参数名 | 参数说明 |
|---|---|
| payCode | 收钱码（收钱码的二维码内容，或唯一标识） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| deviceSN | 设备编号 |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应参数的签名 |
消息推送(指定设备编号)
请求接口：public static String push(String deviceSN, int message, int pushTemplate)
接口功能：向指定的设备推送消息。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号，可以指定设备编号向该设备推送消息 |
| message | 播报金额，int类型，单位：分 |
| pushTemplate | 语音模板（1支付宝；2微信；3扫码（默认）；4银联） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| nonce | 请求时的nonce，原样带回 |
| pushsn | 消息流水号 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
消息推送（使用收钱码）
请求接口：public static String pushByPaycode(String payCode, int message, int pushTemplate)
接口功能：向指定的设备推送语音消息。
| 参数名 | 参数说明 |
|---|---|
| payCode | 收钱码，指定收钱码，向绑定的设备推送消息 |
| message | 播报金额，int类型，单位：分 |
| pushTemplate | 语音模板（1支付宝；2微信；3扫码（默认）；4银联） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| pushsn | 消息流水号 |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
获取设备信息
请求接口：public static String getDeviceInfo(String deviceSN)
接口功能：检查某个指定的设备的信息。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号 |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| status | 设备的状态(0未绑定，1已绑定) |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
设备解绑
请求接口：public static String unbindDevice(String deviceSN)
接口功能：解除终端设备和二维码牌的绑定关系。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号 |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
获取消息列表
请求接口：public static String getMessage(String deviceSN, int startTime, int endTime, int startRow, int pageSize)
接口功能：根据设备id和时间段查询消息列表。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号 |
| startTime | 开始时间时间戳（int类型秒数） |
| endTime | 结束时间时间戳（int类型秒数） |
| startRow | 分页起始行 (>=0) |
| pageSize | 分页每页行数（1<value<100） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| list | 获取的消息列表 |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
获取消息统计信息
请求接口：public static String getMessageStatistics(String deviceSN, int startTime, int endTime)
接口功能：根据设备id和时间段查询消息统计信息。
| 参数名 | 参数说明 |
|---|---|
| deviceSN | 设备编号 |
| startTime | 开始时间时间戳（int类型秒数） |
| endTime | 结束时间时间戳（int类型秒数） |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| success_count | 成功播报的条数 |
| success_rate | 播报的成功率（单位%） |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
查询消息信息
请求接口：public static String getMessageByPushSN(String pushSN)
接口功能：根据消息流水号查询消息信息。
| 参数名 | 参数说明 |
|---|---|
| pushSN | 消息流水号 |
| 参数名 | 参数说明 |
|---|---|
| code | 返回响应码 |
| msg | 结果描述 |
| data | 查询到的消息数据（JSON格式） |
| nonce | 请求时的nonce，原样带回 |
| sign | 响应数据的签名 Base64Url_encode(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |