娃娃机，按摩椅等设备的开放api文档

娃娃机，按摩椅等设备的开放api文档

约定

所有请求参数，以json形式发送
返回参数中包含code和msg,code非0则为失败，msg记录失败信息。失败时，http状态码为非200的值
所有的价格，单位均为分
所有的时间以秒级的时间戳形式传递

Headers的Content-Type

{"Content-Type": "application/json"}

认证

在headers中增加Basic auth的认证，填入(appkey, appsecret)
认证方式为HTTP Basic Authorization，认证信息为appkey:appsecret，详细调用请参考各个语言的HTTP Basic Authorization
appkey和appsecret可以从这里获取
测试用appkey和appsecret可去码夫开源群获取

注意事项

当前仅可以对码夫平台下，appkey,appsecrete对应的账号中的设备，调用接口。

错误码说明

http状态码	code值	msg值	说明
500	1	操作失败	设备异常
400	2	参数错误	json错误或参数错误
401	4	没有权限	appkey,appsecret错误
422	3003	设备已被添加	设备已经存在
422	3007	设备没有权限	没有权限操作该设备
422	5001	代理不存在	该错误与appkey,appsecret有关
422	8001	设备连接超时	设备连接超时，离线或者其他异常
422	8002	设备正在运行	设备正在运行
500	99	server error	服务器错误

host

http://api.openluat.com

接口详细

添加设备

使用场景

添加过的设备，其他接口才有操作权限
请求URL

/mafu/event/add_device
请求方式
>POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
cat	Integer	是	设备类型 0继电器1脉冲

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息

返回示例
```
{
  "code": 0,
  "msg": ""
}
```

启动脉冲设备

使用场景

在确认用户完成支付以后，使用该接口，即可启动设备
请求URL

/mafu/event/launch_pulse_signal_deivce
请求方式
>POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
high	Integer	是	高电平时长，单位为毫秒，最小值为50，具体数值根据投币器决定。
low	Integer	是	低电平时常，单位为毫秒，最小值为50，具体数值根据投币器决定。
pulse	Integer	是	脉冲个数
async_url	String	否	异步通知地址，如果填写改地址，则该接口变为异步接口，该接口立即返回，启动结果将发送到此url

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息

返回示例
```
{
  "code": 0,
  "msg": ""
}
```

启动继电器设备

使用场景

在确认用户完成支付以后，使用该接口，即可启动设备
请求URL

/mafu/event/launch_relay_signal_deivce
请求方式
>POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
duration	Integer	是	时长，单位秒
async_url	String	否	异步通知地址，如果填写改地址，则该接口变为异步接口，该接口立即返回，启动结果将发送到此url

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息

返回示例
```
{
  "code": 0,
  "msg": ""
}
```

启动回调接口

用户调用异步启动接口，当启动成功或失败的时候，回调接口讲被激活

请求URL

启动接口填写的async_url值，以http://或https://开头的url地址
请求方式
>POST
请求参数

请求参数	参数类型	是否必须	参数说明
code	Integer	是	执行结果code，非0表示失败，详情参见错误码说明
msg	String	是	执行结果消息

请求示例
```
{
  "code": 0,
  "msg": ""
}
```
返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败
msg	String	错误原因

返回示例
```
{
  "code": 0,
  "msg": ""
}
```

查询投币接口

使用场景

查询设备的投币情况
请求URL

/mafu/event/offline_coin/fetch
请求方式
>POST
url参数

请求参数	参数类型	是否必须	参数说明
page	Integer	是	页数
psize	Integer	是	页大小

请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
start	Integer	是	查询范围的起始时间，秒级时间戳
end	Integer	是	查询范围的结束时间，秒级时间戳

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息
data	键值对	数据

data

返回参数	参数类型	参数说明
coins	Integer	时间段的硬币总数
count	Integer	总条数
records	数组	数据，内容为键值对

records数组，内容为键值对

参数	参数类型	是否必须	参数说明
time	Integer	是	投币时间，秒级时间戳
coin	Integer	是	投币数量

返回示例

{
  "code": 0,
  "data": {
    "coins": 0,
    "count": 0,
    "records": []
  },
  "msg": ""
}

查询设备状态

使用场景

查询设备的状态
请求URL

/mafu/event/device/status
请求方式
>POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息
data	键值对	数据

data

返回参数	参数类型	参数说明
status	Integer	状态 0离线 1在线 4关机
time	Integer 秒级时间戳	最近一次上报时间
lat	String	纬度
lng	String	经度
satellites	Integer	卫星数
signal	Integer	信号强度

返回示例

{
  "code": 0, 
  "data": {
    "lat": "29.305408", 
    "lng": "120.170724", 
    "satellites": 0, 
    "signal": 0, 
    "status": 0
  }, 
  "msg": ""
}

发送透传信息到设备

使用场景

串口透传
请求URL

/mafu/event/common/transparent
请求方式

POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
message	String	是	信息

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息

返回示例
```
{
  "code": 0,
  "msg": ""
}
```

设备透传转发

使用场景

串口透传
请求URL

用户在mafu平台，平台高级设置中的透传回调地址
请求方式

POST
请求参数

请求参数	参数类型	是否必须	参数说明
imei	String	是	模块imei号
message	String	是	信息

返回参数

返回参数	参数类型	参数说明
code	Integer	执行结果code，非0表示失败，详情参见错误码说明
msg	String	执行结果消息

返回示例
```
{
  "code": 0,
  "msg": ""
}
```
补充说明
该接口需要对接方接收处理，并返回应答。
如果合宙收到对接方的应答状态码不是200或超时，合宙认为通知失败，合宙会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但合宙不保证通知最终能成功。（通知频率为5/15/30/60/120，单位：秒）

注意：同样的通知可能会多次发送给对接方。对接方必须能够正确处理重复的通知。