共享产品-对接API系统基础配置【系统管理员】

API对接 49 次浏览 1小时前

接口文档

API取水、激活接口
https://docs.apipost.net/docs/detail/4a92d4e0dcd2000?locale=zh-cn&target_id=290774013a6003
密码：[联系跃龙工作人员获取]

共享产品-对接API物联网系统基础配置

请提供两个跳转链接。
1、设备二维码跳转链接：设备二维码地址默认访问跃龙域名，请提供你们域名，我们做特殊处理进行跳转，跳转后会附带设备ID到你们的地址。[设备激活、设备扫码取水都要用到。]
2、用水记录回调链接：用水结束后会将设备用水记录推送给你们，需要你们提供一个地址。

1.添加经销商----<必要配置>`

路径：后台-经销商管理-经销商列表-添加
添加方法：输入经销商基础信息后，点击确定，完成添加。

image.png

2.添加项目----<必要配置>（也可通过接口在激活时自动添加）`

路径：后台-项目管理-项目列表-添加
!!!注意：项目编号不是项目ID，在创建时手动设置项目编号!!!
添加方法：输入项目基础信息后，点击确定，完成添加。
注：此处冷水费率、热水费率可默认填写1。【优先级最低】
注：项目和经销商关联。
多设备使用统一项目时，建议在此添加后，激活时调用统一的项目编号！

image.png

3.添加滤芯----<按需配置>

路径：后台-配置管理-滤芯管理-添加
添加方法：输入滤芯基础信息，完成添加。
注：一般需要创建多次。【有多少级、多少类滤芯，则需添加多少次。家用机一般为5级滤芯，一般需要添加5次】
注：若为水控机、管线机等无滤芯类型的设备，此项可不创建。

image.png

4.添加型号----<必要配置>

路径：后台-配置管理-型号管理-添加
添加方法：
1-输入型号名称；
注：若出现经销商选项，可不选择经销商。若选择经销商，则型号为经销商专用型号。
2-选择型号类别:一般售水机选择“售水机L”即可。（管线机选择“管线机（内胆）”，洗浴水控选择“洗浴水控”，饮水水控选择“双温水控盒”，W40型号主板选择“售水机(双温-制水)”，支持双路同时出水的售水机选择“售水机-多口”），
3-输入型号编号（自定义）；
4-上传型号图片（非必填）；
5-选择滤芯模式[此项非必填，无滤芯类型设备此项自动隐藏]（选择“时长或流量”，若没有“时长或流量”，则选择能看到的滤芯类型。设备滤芯实际计算方式以主板生产时订单设备参数为准，设备主板仅支持一种计算类型。）
注:计费模式非必选，若选择计费模式，则指定型号计费模式，若不选择，则不指定。（按需设置）
注：RO膜位置暂无实际意义，正常选择RO膜属于哪一级即可即可。
6-选择滤芯[此项非必填，无滤芯类型设备此项自动隐藏]（先选择第一级滤芯，然后点击滤芯箭头添加到型号中，然后在选择第二级滤芯，再点击箭头添加到型号中，依次重复上面步骤，完成添加。！不可一次选中五级滤芯，直接点箭头添加，滤芯顺序可能会错！）
点击添加完成创建。


型号ID可以在创建完成后的型号列表查看！

以上是基础配置：配置完后熟悉流程的即可进行对接

关于扫码打水接口
0783a202baf1f85673d8206126b8b02c.png

outlet依据设备
scan_type固定传1即可
flow传取水量（常用数值有：5000ml、7500ml）
time传最大取水时间（常见数值有：300秒、600秒）
wait_time传取水前的最大等待时间（常见：15秒、30秒等）
pause_time传取水中间暂停的最大等待时间（常见：15秒、30秒等）

新API系统对接水卡。
所有IC卡的开卡、充值等功能，不再对接到跃龙系统，请业务系统自行管理水卡。

刷卡取水流程：
用户刷卡-跃龙服务器将水卡信息通过接口回传到业务系统-业务系统判断是否允许水卡取水-允许取水后调用扫码取水接口即可。

【水卡采购后需要在跃龙系统入库后才会回传】

关于回调：
刷卡取水与API取水, 用水回调中的【data_type】都是【5】，当刷卡取水时，回调中的【iccard】会携带卡号，你可以用这个进行区分取水方式。

--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------分割线-------------------------------------------------------------------------------------------
下方是跃龙现有功能的流程，在开发是可以供做参考。

1、安装激活设备流程

方法：扫描设备二维码（首次扫码使用需要点击使用完整服务）授权之后，填写基础信息，（弹窗获取地址时请选择允许）完成激活。

先输入经销商ID
选择项目（若无项目则联系平台管理员，创建此经销商的项目）
选择型号（若无可选型号则联系平台管理员，创建此通用型号或经销商专用型号）
计费模式选择共享！
完善其他信息，完成激活。

设备激活需要设备通电 且联网正常，否则无法激活设备
图片alt

2、设备参数调整配置

路径：后台-设备管理-设备列表-参数配置
注：调整脉冲、单次最大出水量等参数修改均在此处设置{单次最大出水量对刷卡生效即刷卡后单次允许最大的出水量}。
注：售水机可在此处调整费率、臭氧杀菌、浴霸等功能。
图片alt

3、用户端常用功能介绍

3.1、套餐取水

用户扫描设备二维码授权后，即可进入设备首页。（首次扫码使用需要点击使用完整服务）
情况1-未充值钱包余额：未充值钱包套餐的用户可以看到扫码取水套餐，扫码套餐包含套餐名称、价格、取水量信息，用户按需选择设置的套餐后，然后进行微信支付（价格按扫码套餐设置的价格），支付完成后在设备上按取水按键即可完成取水。
情况2-已充值钱包余额：用已充值钱包的用户可以直接看到扫码取水套餐，扫码套餐包含套餐名称，用户按需选择取水套餐，选中后按确定即可去设备上按取水按键进行取水。取水完成后会系统会自动扣除钱包内的余额（实际费用=实际取水量*设置的共享单价）。
图片alt

扫码取水失败

关于扫码取数付费后，没取水的结果：
用户付费后，等待15秒没取水，会取水超时，结束本次取水。正常情况下：此时钱会充值到钱包内，用户可以再次扫码取水（无需再付费）。特殊情况下（断网）无法充值到钱包。（需要人工对该笔订单和用户进一步处理。）

返回 API对接