智能锁LG-01 API文档

url = 双方既定的域名/IP

token = 双方既定的token规则(暂为设备编号),当接口不需传设备编号时,token传空字符串

请求方式:POST

返回格式:JSON


一、操作设备基础接口

1.执行开锁。

接口地址:url/api/doOpen

参数:

  • num 设备编号(=device_num为了传参方便简写为num)

  • token

返回示例:

{
       "reason":"success",
       "error_code":0
}


2.获取单车全部信息

接口地址:url/api/getInfo

参数:

  • num 设备编号(=device_num为了传参方便简写为num)

  • token

返回示例:

{

    "error_code": 0,

    "reason": "success",

    "result":  {

            "device_num": "869013029999982",

            "status": 4,

            "vol": 90,

            "open": 1,

            "iccid": "879031B83123990",

            "moment": 1,

            "longitude": "119.241030",

            "latitude": "36.435419",

            "add_time": "2017-10-11 19:00:00",

            "disconn_time":"2017-10-11 19:00:00"

        }

}

说明:

device_num(重要参数): 设备编号,为设备的唯一身份码,由客户提供编号规则,出厂时刷入设备,长度为15位。

status(重要参数):状态

0 = 普通上传坐标状态

1 = SOS紧急求救状态

2 = ACC打火工作状态

3 = ACC 熄火状态

4 = GPS异常

5 = 设备异常

6 = 解锁上传

7 = 闭锁上传

8 = 车辆非法移动

9 = 其他异常上传

vol(重要参数):电池电量

open:解锁/闭锁状态,

0 = 闭锁

1 = 解锁

2 = 未知

iccid:ICCID号,用于插入SIM卡的ICCID号,此处获取到SIM卡的ICCID号后,方便后台自动识别手机卡号功能。长度20位 。

moment(重要参数):开闭锁瞬间上传:平时上传0,闭锁瞬间是1,开锁瞬间2,刷卡上传3

longitude(重要参数):经度

latitude(重要参数):纬度

add_time(重要参数):设备上传时间

disconn_time(重要参数):设备掉线时间(正常的设备,此字段为空)

 

3.获取单车(最近一次)运行轨迹

接口地址:url/api/getTravel

参数:

  • num 设备编号(=device_num为了传参方便简写为num)

  • token

返回示例:

{

    "error_code": 0,

    "reason": "success",

    "result": [{

            "device_num": "869013029999983",

            "status": 4,

            "open": 1,

            "moment": 2,

            "longitude": "119.241030",

            "latitude": "36.435419",

            "add_time": "2017-10-11 19:00:00"

        },

        {

            "device_num": "869013029999983",

            "status": 4,

            "open": 1,

            "moment": 1,

            "longitude": "119.241030",

            "latitude": "36.435419",

            "add_time": "2017-10-11 19:00:00",

        }]

}


4.执行修改设备ip、端口(谨慎调用)

接口地址:url/api/doChange

参数:

  • num 设备编号(=device_num为了传参方便简写为num)

  • ip 新ip地址

  • port 新端口

  • token

返回示例:

{

        "reason":"success",

        "error_code":0

}


5.获取服务器软件当前连接设备

接口地址:url/api/getConnection

参数:

  • token

返回示例:

{

        "reason":"success",

        "error_code":0,

        "result":{

                "conn_count":3,

                "conn_list":"0000000001,0000000002"

        }

}


6.获取中心坐标附近设备

接口地址:url/api/getNearby

参数:

  • token

  • longitude 经度,示例:104.061827

  • latitude 纬度,示例:30.539623

  • level 地图级别,默认18,地图级别越小,搜索范围越大。搜索半径=(19 - level)*500米

返回示例:

{

        "reason":"success",

        "error_code":0,

        "result":[

                {

                    "vol":    "79"    

                    "latitude":    "30.543246896663767"   

                    "device_num":    "0100140016"    

                    "longitude":"104.07080247537893"

                    "distance": 5

                }

        ]

}

说明:

由于设备上传的坐标为GPRS坐标,需进行对应地图供应商的坐标转换后比对距离,此处暂采用百度地图坐标转换


错误码error_code参照:

10000:非法请求

10001:参数错误

10002:验证失败

10004:未查询到数据

10005:服务器软件返回错误

10006:connot find connection(找不到设备与服务器的连接)

 

二、服务器软件主动推送开闭锁瞬间状态或报警信息到客户接口


闭锁时,由于机械闭锁,App直接拿不到闭锁信息,所以需要客户提供一个接口,由服务器软件发送到接口开闭锁信息,客户通过类似极光推送、小米推送的服务,推送到App

接口地址: http://客户提供/api/lockCallBack(接口名称任意)

示例:post_data =>

{

        "error_code":0,

        "reason":"success",

        "result":{

                "device_num":"0000000001",

                "status":1,

                "longitude":"119.241030",              

                "latitude":"36.435419",                    

                "add_time":"2017-10-11 19:00:00"

        }

说明:

device_num 设备编号

status 操作码:1开锁,2闭锁,3非法移动,4拆卸报警,5设备异常,6其他异常

add_time   时间

 

 

说明:为提高传输数据的效率、安全性,防止网络异常等一系列问题,将用户端web系统、设备端web系统、服务器软件全部本地端口传输


三、刷卡开锁接口(已停止维护)


服务器软件检测到刷卡操作后,向用户端发送卡号等JSON串,用户端查询并判断该卡是否可以正常使用,调用doOpen接口开锁。

接口地址: http://客户提供/api/getCardStatus(接口名称任意)

示例:postdata =>

{

"error_code":0,

        "reason":"success",

        "result":{

                "device_num":"010011710171001",

                "card_num":"898602B9191750713200",

                "longitude":"119.241030",

                "latitude":"36.435419",

                "add_time":"2017-10-11 19:00:00"

        }

说明:

device_num 设备编号

iccid 卡号

add_time   刷卡时间