汽车在线OPEN API文档

接口说明：
获取一个访问。

URL：
http://api.gpsoo.net/1/auth/access_token?

HTTP请求方式：
GET/POST

输入参数说明：

请求示例：
http://api.gpsoo.net/1/auth/access_token?account=testacc&time=1366786321&signature=e9b39daacc811af7109ef1e11a6583bd

返回参数说明：

正确返回示例：

	{
	"ret":0,
	"msg":"",
	"access_token"：" 13667863217ac80dbbaaf3c74cec21f6d6867bff43",
	"expires_in":7200
	}
	

错误返回示例：

	{"ret":20001,"msg":"账号或密码错误"}
	

特别说明：
(1) access_token 2小时内有效， 不要频繁调用；
(2) 请勿在服务端代码以外的地方使用该access_token；
(3) 调用接口的时候返回10006 (access_token已过期) 错误，就需要重新请求access_token。

接口说明：
获取一个账户名下所有设备最新位置信息

URL：
http://api.gpsoo.net/1/account/monitor

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/account/monitor?access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5&map_type=BAIDU&target=mycar&account=testacc&time= 1366786321

返回参数说明：

正确返回示例：

	{ 
	"ret":0,
	"msg":"",
	"data"： [{
		"imei": "353419031939627",
		"device_info":0,
		"gps_time": 1318409927,
		"sys_time": 1318409919,
		"heart_time": 1318409919,
		"server_time": 1318428292,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 100,
		"speed": 80,
		"acc": "1",
		"acc_secconds" : 3600
	},
		{ 
		"imei": "353419032982170",
		"device_info":0,
		"gps_time": 1318409927,
		"sys_time": 1318409919,
		"heart_time": 1318409919,
		"server_time": 1318428292,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 100,
		"speed": 80,
		"acc": "1",
		"acc_secconds" : 3600	
	}]
	}
	

错误返回示例：

	{"ret":20005,"msg":"无权查看该账号信息(mycar)"}
	

特别说明：
(1) 若已知设备号， 请用下面的tracking接口， 一次性获取多台设备的位置信息。 父帐号对子帐号的设备是有权限查看的， 不必为每个子帐号去调用monitor接口。

接口说明：
获取单个/批量设备最新位置信息

URL：
http://api.gpsoo.net/1/devices/tracking

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/devices/tracking?access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5&map_type=BAIDU &account=testacc&imeis=353419031939627,353419032982170&time=1366786321

返回参数说明：

正确返回示例：

	{ 
	"ret":0,
	"msg":"",
	"data"： [{
		"imei": "353419031939627",
		"device_info":0,
		"gps_time": 1318409927,
		"sys_time": 1318409919,
		"heart_time": 1318409919,
		"server_time": 1318428292,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 100,
		"speed": 80",
		"acc": "1",
		"acc_secconds" : 3600
	},
		{  
		"imei": "353419032982170",
		"device_info":0,
		"gps_time": 1318409927,
		"gps_time": 1318409919,
		"heart_time": 1318409919,
		"server_time": 1318428292,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 100,
		"speed": 80,
		"acc": "1",
		"acc_secconds" : 3600
	}]
	}
	

错误返回示例：

	{"ret":20007,"msg":"IMEI不存在(353419031939627)"}
	

接口说明：
获取设备历史轨迹位置信息

URL：
http://api.gpsoo.net/1/devices/history

HTTP请求方式：
GET

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/devices/history?access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5&map_type=BAIDU &account=testacc&imei=353419031939627&time=1366786321&begin_time=1452754256&end_time=1452954256

返回参数说明：

正确返回示例：

	{
	"ret":0,
	"msg":"",
	"data":[{
		"gps_time": 1318409927,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 200,
		"speed": 80
		},{
		"gps_time": 1318410927,
		"lng": 113.91919,
		"lat": 22.54546,
		"course": 180,
		"speed": 80}]
	}
	

错误返回示例：

	{"ret":20007,"msg":"IMEI不存在{353419031939627}"}
	{"ret":20010,"msg":"该设备已过期{353419031939627}"}
	

特别说明：
每次获取数据最多只能获取1000条，如果想回放很长一段时间的历史轨迹，需要不断的获取数据，每次获取1000条，然后以最后一条数据的定位时间作为起始时间再次请求获取数据，如果获取的数据少于1000条，表示这段时间内的gps数据已经全部获取完毕，不需要再发请求。

接口说明：
根据经纬度得到中文地址

URL：
http://api.gpsoo.net/1/tool/address/

HTTP请求方式：
GET

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例： http://api.gpsoo.net/1/tool/address?lng=114.342155&lat=30.682749&access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5 &account=testacc&time=1366786321
表示请求经度为114.342155，纬度为30.682749的地址 (经纬度是原始值)
http://api.gpsoo.net/1/tool/address?lng=114.343088&lat=30.682888&access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5 &account=testacc&map_type=BAIDU&time= 1366786321
表示请求经度为114.343088，纬度为30.682888的地址 (经纬度不是原始值，该经纬度是经过了百度校准过的经纬度)
http://api.gpsoo.net/1/tool/address?lng=114.343231&lat=30.682345&access_token=0011045701369822736adb020814946df1ded1c8681d026d5c5 &account=testacc&map_type=BAIDU&time= 1366786321
表示请求经度为114.343231，纬度为30.682345的地址 (经纬度不是原始值，该经纬度是经过了GOOGLE校准过的经纬度)

返回参数说明：

正确返回示例：

	{
	"ret":0,
	"msg":"",
	"address":"湖北省武汉市堤边路.离新队约78米. "
	}
	

错误返回示例：

	{"ret":20002,"msg":"缺失必选参数(lng) ,请参考API文档"}
	

接口说明：
查询账号下所有设备的相关信息，（注意：返回结果最多为2000，设备数超过2000时按设备号顺序返回前2000条数据）

URL：
http://api.gpsoo.net/1/account/devinfo

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例： http://api.gpsoo.net/1/account/devinfo?target=test&account=test&access_token=200071015892101425870161325c151729a416478ac71fe7588b70609800010010014010 &time=1386655342

返回参数说明：

正确返回示例：

	{
		"data": [
		{
				"imei": "684611121300041", 
				"name": "goome-00041", 
				"number": "", 
				"phone": "", 
				"group_id": 0, 
				"group_name": "", 
				"dev_type": "X9", 
				"in_time": 1323705600, 
				"out_time": 1862928000, 
				"sudu": "0", 
				"efence_support": true,
			}
		], 
		"children"：
		[
					{
						"id"   : “456789”,
						"name" : “wangtao888”,
						"showname" : “wangtao888”,
						"owner" : 联系人,
						"msisdn" : 设备使用的物联卡号码,
						"tel" : 联系人电话,
						"deviceremark" : 设备备注,
					},
					{
						"id"   : “子客户ID”,
						"name" : “子客户登录名”,
						"showname" : “子客户名称”,
						"owner" : 联系人,
						"msisdn" : 设备使用的物联卡号码,
						"tel" : 联系人电话,
						"deviceremark" : 设备备注,
					}
		],
		"ret": 0, 
		"msg": ""
	}
	

错误返回示例：

	{"ret":20002,"msg":"缺失必选参数(target) ,请参考API文档"}
	

接口说明：
查询是否为黑名单

URL：
http://api.gpsoo.net/1/tool/blacklist

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例： http://api.gpsoo.net/1/tool/blacklist?target=test&account=test&access_token=200071015892101425870161325c151729a416478ac71fe7588b70609800010010014010 &time=1386655342&cardno=42027377373788

返回参数说明：

正确返回示例：

	{
		"data": true, 
		"ret": 0, 
		"msg": "" 
	}
	当access_type=inner，返回格式：
	{
		"data": true, 
		"success": true,
		"errcode": 0,
		"msg": "" 
	}
	

错误返回示例：

	{"ret":20002, "msg":"缺失必选参数，请参考API文档"}
	当access_type=inner，返回格式：
	{"success":false, "errcode":20002, "msg":"缺失必选参数，请参考API文档"}
	

接口说明：
获取指定时间段内产生的告警总数。

URL：
http://api.gpsoo.net/1/tool/get_alarminfo?method=getAlarmOverviewCount

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/tool/get_alarminfo?method=getAlarmOverviewCount&
access_token=20007346330810153675108132688253b509b2aa04768b3a4782286b5f0000010014010&
account=fangtonghe&imei=&login_type=user&timestamp=0

返回参数说明：

正确返回示例：

	{
		"ret":0,
		"msg":"",
		"data":{"count":29}
	}
						

错误返回示例：

	{
		"ret":10001,
		"msg":"系统错误(1303)",
		"data":{}
	}
						

接口说明：
获取指定时间段内某一种告警类型或者多种告警类型的详细告警信息。

URL：
http://api.gpsoo.net/1/tool/get_alarminfo?method=getAlarmDetail

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

next:向后查询  
									previous：从指定的时间向前查询 
									

请求示例：
http://api.gpsoo.net/1/tool/get_alarminfo?method=getAlarmDetail&
access_token=20007346330810153675108132688253b509b2aa04768b3a4782286b5f0000010014010&account=fangtonghe&
alarm_type=1&imei=&login_type=user&page_dir=next&pagesize=10&timestamp=0

返回参数说明：

正确返回示例：

	{
		"ret":0,
		"msg":"",
		"data":
			[{
				"id":"4702725901",
				"alarm_type_id":"1",
				"alarm_type":"Vibrationalarm",
				"alarm_time":1536803851,
				"gps_time":1536803849,
				"dev_name":"goome-64463",
				"dev_type":"GT03C",
				"speed":"0",
				"imei":"868120193064463",
				"gps_status":"01000000000000000000000000000000",
				"dir":"144",
				"address":"广东省东莞市东莞市市辖区青塘路.离凤岗福斌卫生所约19米",
				"lng":"114.176",
				"lat":"22.721124444"
			},
			{
				"id":"3441575131",
				"alarm_type_id":"1",
				"alarm_type":"Vibration alarm",
				"alarm_time":1536803541,
				"gps_time":1536803531,
				"dev_name":"宝马61433",
				"dev_type":"GT03C",
				"speed":"65",
				"imei":"868120200261433",
				"gps_status":"01000000000000000000000000000000",
				"dir":"14",
				"address":"湖南省长沙市浏阳市008县道.离韩家湾(东北)约280米",
				"lng":"113.70779556",
				"lat":"27.965113333"
			}]
	}

						

错误返回示例：

			{
				"ret":10001,
				"msg":"系统错误(1303)",
				"data":{}
			}
								

接口说明：
获取指定时间段内单个或者多个设备的里程统计信息。

URL：
http://api.gpsoo.net/1/tool/runstatus?method=milestat

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/tool/runstatus?method=milestat&
imei=358899052202812&beginTime=1538262000&endTime=1538999476&timezone=1
&_=1480304604876&access_token=20007348292810153900038532704fc002284862a258533dd63062f3790000010014010

返回参数说明：

正确返回示例：

			{
				"ret":0,
				"msg":"OK",
				"summary": {
					"totalmilestat":2330,
					"totaloutspeed":344,
					"totalstop":75
				},
				"keys":{
					"imei":0,
					"datetime":1,
					"milestat":2,
					"outspeed":3,
					"outspeedlimit":4,
					"stop":5
				},
				"data":[
					["358899052202812","2018-09-30","281","11","110","8"],
					["358899052202812","2018-10-01","442.5","103","110","15"],
					["358899052202812","2018-10-02","417.9","84","110","10"],
					["358899052202812","2018-10-03","432","43","110","10"],
					["358899052202812","2018-10-04","418.4","73","110","19"],
					["358899052202812","2018-10-05","338.3","30","110","13"],
					["358899052202812","2018-10-06","0","0","110","0"],
					["358899052202812","2018-10-07","0","0","110","0"],
					["358899052202812","2018-10-08","0","0","110","0"]
				]
			}

								

错误返回示例：

					{
						"ret":10001,
						"msg":"系统错误(1303)",
						"data":{}
					}
										

接口说明：
获取指定账户下车牌号对应的设备信息。

URL：
http://api.gpsoo.net/1/devices/search?method=plateSearch

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/devices/search?method=plateSearch&account=seeworld&target=白色宾智&plate=粤MRV856&access_token=2000710019521015427620483291bedd1446045efcbcbeb54479398f0b0000010014010

返回参数说明：

正确返回示例：

{
	"ret":0,
	"msg":"OK",
	"data":[
		{"user_id":2138006,
		"school_id":2702043,
		"imei":"868120118654471",
		"user_name":"粤M.RV856",
		"phone_num":"14701421186",
		"use_time":"2015-03-16",
		"car_num":"粤MRV856",
		"user_type":"GT06N",
		"remarks":""}
	]

}

错误返回示例：

{"ret":10001,"msg":"系统错误(1303)","data":{}}

接口说明：
对指定的设备下发指令。

URL：
http://api.gpsoo.net/1/tool/order?method=sendDirectOrder

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/devices/search?method=sendDirectOrder&imei=358899052202812&order_content=PARAM%23&
access_token=2000710019521015427620483291bedd1446045efcbcbeb54479398f0b0000010014010

返回参数说明：

正确返回示例：

{
	"ret":0,
	"msg":"OK",
	"data":[
	{"id":2138006}
	]
}
						

错误返回示例：

{"ret":10001,"msg":"系统错误(1303)","data":{}}
	

接口说明：
获取对设备下发指令的结果。

URL：
http://api.gpsoo.net/1/tool/order?method=get_response

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/devices/search?method=get_response&imei=358899052202812&id=123545
&access_token=2000710019521015427620483291bedd1446045efcbcbeb54479398f0b00000100

返回参数说明：

正确返回示例：

{
	"ret":0,
	"msg":"OK",
	"data":[
	{"response":”xxxxxxxxxx”}
	]
}
						

错误返回示例：

{"ret":10001,"msg":"系统错误(1303)","data":{}}
	

接口说明：
用户调用告警推送订阅接口订阅告警通知，告警推送数据按照T809约定的告警推送协议推送给订阅方，因此要求订阅方实现T809的服务端接收告警推送数据，并在调用订阅接口时，携带接收告警推送数据的地址、鉴权信息、要订阅设备所属用户id、告警推送订阅时长等信息。

URL：
http://api.gpsoo.net/1/tool/get_alarminfo?method=subscribeAlarmPush

HTTP请求方式：
GET/POST

输入参数说明：
（1）通用参数
参见：通用参数
（2）私有参数

请求示例：
http://api.gpsoo.net/1/tool/get_alarminfo?method=subscribeAlarmPush&plat_host=221.224.36.194&plat_port=4999&userid=2159402&passwd=szth&target=apptest&expires_in=300&access_token=20007424906510167160612532ffc69814317d3791b1bc30ce72b4fe340000010018010&access_type=outer

返回参数说明：

正确返回示例：
{"ret":0,"msg":"","data":{}}

错误返回示例：
{"ret":10001,"msg":"系统错误(1303)","data":{}}

告警推送协议：
告警推送采用T809的告警推送协议（参考T809 4.5.5），需要接收方实现T809的服务端，并在调用告警推送接口时将服务端相关信息以参数的方式告知。
告警推送业务数据类型：UP_WARN_MSG
子业务数据类型：UP_WARN_MSG_ADPT_INFO

告警推送数据格式定义：
typedef struct

{
	uint8_t warn_src;    //报警信息来源 0x01 车载终端 0x02 企业监控平台
	uint16_t warn_type;  //报警类型 
	uint64_t warn_time;  //报警时间 UTC时间格式
	uint32_t info_id;    //信息ID
	uint32_t info_length;//信息数据长度
	std::string info_content; //信息数据内容
}__attribute__((packed)) T809_UP_WARN_MSG_ADPT_INFO;
						

其中info_content是json序列化后的平台告警数据，字段格式参考示例：

{
	"dev_id":3710,
	"imei":"868120193064463",
	"dev_name":"goome-64463",
	"dev_type":"GT03C",
	"alarm_type_id":"1",
	"alarm_type":"Vibrationalarm",
	"alarm_time":1536803851,
	"gps_time":1536803849,
	"speed":"0",
	"dir":"144",
	"lng":"114.176",
	"lat":"22.721124444"
}
						

一个服务器的访问频率不能超过 600次/分钟，如果需要更高的访问频率授权，请联系我们。

目前默认access_token 的有效期是2小时。

1. 定位时间(datetime): 终端设备上来的gps定位时间，是卫星时间
2. 系统时间(systime): 终端设备上来定位数据的时候，服务器的时间，即这条数据上来的时候的服务器时间
3. 心跳时间(heartTime):心跳时间，即终端设备上来心跳数据包的时间(是服务器时间)
4. 服务器时间(servertime):服务器向页面或终端回复数据时的当前服务器时间
补充：andriod等客户端请求设备的位置的数据的时候，会带下去一个serverTime的时间，这个是android客户端请求位置数据时，服务器的时间。即这次请求的时候服务器的时间。给android用来判断设备的运动状态用的

终端设备有 未上线，静止，运动，离线 4种状态
服务器时间:servertime,定位时间:datetime,心跳时间:heart_time,系统时间:sys_time
a:服务器时间-定位时间 b:服务器时间-心跳时间 c:服务器时间-系统时间
未上线: 速度为-9，且b 大于1500秒，判断为未上线。
离线: 如果b和c中的最小值大于1500秒(即重新搜网25分钟没有收到心跳)，就判断该设备处于离线状态。
静止: 如果a大于35秒(即连续俩个信号周期没有定位)就判断设备处于静止状态， 或者是速度小于某个指定值,以gt02为例,如果速度不大于10(静态漂移)则为静止。
运动: a <=35秒，判定为运动，行驶中。