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对应的账号中的设备，调用接口。

错误码说明

host

http://api.openluat.com

接口详细

添加设备

• 使用场景

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

• 请求URL

  /mafu/event/add_device

• 请求方式 

  POST

• 请求参数

• 返回参数

• 返回示例

  {
    "code": 0,
    "msg": ""
  }

启动脉冲设备

• 使用场景

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

• 请求URL

  /mafu/event/launch_pulse_signal_deivce

• 请求方式 
  POST

• 请求参数

• 返回参数

• 返回示例

  {
    "code": 0,
    "msg": ""
  }

启动继电器设备

• 使用场景

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

• 请求URL

  /mafu/event/launch_relay_signal_deivce

• 请求方式 
  POST

• 请求参数

• 返回参数

• 返回示例

  {
    "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，单位：秒）

            
            

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