使用流程
第一步:创建我的应用
为了正常运行开发环境,您需要建立一个应用并获得相应的【应用标识】、【应用安全密钥】和【应用服务器地址】,具体步骤如下:
1.点击进入飞天智能管理平台登录页面,登录飞天智能管理平台。
2.在管理平台左侧列表中,点击【添加应用】,跳转至添加应用界面,进行应用添加。
3.输入【应用名称】,应用描述(可选),点击【保存】按钮后,页面跳转至应用列表可查看新添加应用的【应用标识】【应用安全密钥】【应用服务器地址】等关键信息,在API初始化时需要用到这些参数。
第二步:下载 Java SDK,请点击下面下载图标:
第三步:初始化
请求接口:public static void init(String serverUrl, String appKey, String appSecret)
接口功能:通过飞天的Java SDK与飞天智能物联网平台进行集成,需要先调用该初始化接口,此接口只需要调用一次。
参数名 | 参数说明 |
---|---|
serverUrl | 应用服务地址 |
appKey | 应用标识 |
appSecret | 应用安全密钥 |
参数名 | 参数说明 |
---|---|
无 | 无 |
第四步:集成您需要的接口
初始化完成之后,您可以根据您的业务需要进行接口集成,请参见SDK接口详细介绍
SDK初始化
请求接口: public static void init(String serverUrl, String appKey, String appSecret)
接口功能:通过飞天的Java SDK与飞天智能物联网平台进行集成,需要先调用该初始化接口,此接口只需要调用一次。
参数名 | 参数说明 |
---|---|
serverUrl | 应用服务地址 |
appKey | 应用标识 |
appSecret | 应用安全密钥 |
参数名 | 参数说明 |
---|---|
无 | 无 |
设备绑定
请求接口: public static string bindDevice(String deviceSN, String paycode)
接口功能:将终端设备和商户二维码牌进行绑定。上传设备编号、二维码牌标识推送给消息服务平台,验证通过后,将此设备和码牌进行绑定。
参数名 | 参数说明 |
---|---|
deviceSN | 设备编号 |
paycode | 收钱码(收钱码的二维码内容,或唯一标识) |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
消息推送(使用设备码)
请求接口:public static String push(String deviceSN, int message, int pushTemplate)
接口功能:向指定的设备推送消息。
参数名 | 参数说明 |
---|---|
deviceSN | 设备编号,可以指定设备编号向该设备推送消息 |
message | 播报金额,int类型,单位:分 |
pushTemplate | 语音模板(1支付宝;2微信;3扫码(默认);4银联) |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
nonce | 请求时的nonce,原样带回 |
pushsn | 消息流水号 |
sign | 响应数据的签名 Base64(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 | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
消息推送(使用设备码)
请求接口:public static String push(String deviceSN, int message, int pushTemplate, String ticketInfo, int ticketTemplate)
接口功能:云打印播报一体机指音箱在播报收款金额的同时打印商品消费明细小票。向指定的设备推送语音消息,根据打印模版打印商品消费明细小票。
参数名 | 参数说明 | |
---|---|---|
deviceSN | 设备编号,可以指定设备编号向该设备推送消息 | |
message | 播报金额,int类型,单位:分 | |
pushTemplate | 语音模板(1支付宝;2微信;3扫码(默认);4银联) | ticketInfo |
|
ticketTemplate | 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印 |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
nonce | 请求时的nonce,原样带回 |
pushsn | 消息流水号 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
消息推送(使用收钱码)
请求接口:public static String pushByPaycode(String paycode, int message, int pushTemplate, String ticketInfo, int ticketTemplate)
接口功能:云打印播报一体机指音箱在播报收款金额的同时打印商品消费明细小票。向指定的设备推送语音消息,根据打印模版打印商品消费明细小票。
参数名 | 参数说明 | |
---|---|---|
paycode | 收钱码,指定收钱码,向绑定的设备推送消息 | |
message | 播报金额,int类型,单位:分 | |
pushTemplate | 语音模板(1支付宝;2微信;3扫码(默认);4银联) | ticketInfo |
|
ticketTemplate | 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印 |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
nonce | 请求时的nonce,原样带回 |
pushsn | 消息流水号 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
TTS消息推送(使用设备码)
请求接口:public static String pushTTS(String deviceSN, String message, String ticketInfo, int ticketTemplate)
接口功能:向指定的设备推送文本语音消息,并附带打印参数。针对播报打印一体机播报并打印。
参数名 | 参数说明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
deviceSN | 设备编号,可以指定设备编号向该设备推送消息 | |||||||||
message | 播报消息内容(使用utf-8编码,最长60字) | |||||||||
ticketInfo |
|
ticketTemplate | 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印 |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
pushsn | 消息流水号 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
TTS消息推送(使用收钱码)
请求接口:public static String pushTTSByPayCode(String paycode, String message, String ticketInfo, int ticketTemplate)
接口功能:向指定的设备推送文本语音消息,并附带打印参数。针对播报打印一体机播报并打印。
参数名 | 参数说明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
paycode | 收钱码,指定收钱码,向绑定的设备推送消息 | |||||||||
message | 播报消息内容(使用utf-8编码,最长60字) | |||||||||
ticketInfo |
|
ticketTemplate | 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印 |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
pushsn | 消息流水号 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
TTS消息推送(使用设备码)
请求接口:public static String pushTTS(String deviceSN, String message)
接口功能:向指定的设备推送语音消息,不需要预先添加模板,使用平台的TTS功能。
参数名 | 参数说明 |
---|---|
deviceSN | 设备编号 |
message | 播报消息内容(使用utf-8编码,最大60字) |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
pushsn | 消息流水号 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
TTS消息推送(使用收钱码)
请求接口:public static String pushTTSByPayCode(String paycode, String message)
接口功能:向指定的设备推送语音消息,不需要预先添加模板,使用平台的TTS功能。
参数名 | 参数说明 |
---|---|
paycode | 收钱码,指定收钱码,向绑定的设备推送消息 |
message | 播报消息内容(使用utf-8编码,最长60字) |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
pushsn | 消息流水号 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |
优惠金消息推送(使用设备码)
请求接口:public static String push(String deviceSN, int message, int pushTemplate, int discountAmt, int discountTemplate)
接口功能:向指定的设备推送语音消息。
参数名 | 参数说明 |
---|---|
deviceSN | 设备编号,可以指定设备编号向该设备推送消息 |
message | 播报金额,int类型,单位:分 |
pushTemplate | 语音模板(1支付宝;2微信;3扫码(默认);4银联) |
field_discount_amt | 优惠金额,单位:分 |
field_discount_template | 优惠金额模板 |
参数名 | 参数说明 |
---|---|
code | 返回响应码 |
msg | 结果描述 |
pushsn | 消息流水号 |
nonce | 请求时的nonce,原样带回 |
sign | 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同 |