酷米客平台开放API接口

发布于 2018-11-13 | 作者: 深圳市谷米科技有限公司 | 来源: 酷米客 | 转载于: 酷米客

酷米客平台开放API接口
(返回消息中如果经纬度都为0，表示定位失败)

注册

URL(示例)

http://api.coomix.net/GetDataService?method=registRegUser

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
phoneNum true string 用户名
pwd true string 用户密码
sex true number(1:女 2：男) 性别
userName true string 用户名

返回结果

{
	"success":true,
	"userID":687313
}
或
{
	"success":false,
	"type":"double"
}

输出参数备注：

"success":是否成功(true || false)
"userID":用户米号
"type":失败原因(double:帐号重复)

验证帐号(手机号码)是可用的

URL(示例)

http://api.coomix.net/GetDataService?method=getPhoneNum

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
phoneNum true string 手机号码

返回结果

{
	"success":true
}
或
{
	"success":false,
	"type":"double"
}

输出参数备注：

"success":帐号是否可用(true为可用)
"type":不可用类型(double:重复)

登录

URL

http://api.coomix.net/GetDataService?method=weblogin

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
userID true string 手机号/帐号/米号
pwd true number 用户密码

返回结果

{
	"userID":126388,
	"status":"D302B",
	"imei":"864717001058332",
	"userName":"Cindy",
	"key":"xxx",
	"success":true
}
或
{
	"type":"pwd",
	"success":false
}

输出参数备注：

"userID":用户id
"status":设备类型
"imei":设备IMEI，没有则显示用户ID
"userName":用户昵称
"key": 用户认证字符串，登录成功后向其他接口发送请求时需带上该参数(key="xxx")。
"success":操作是否成功(true:成功 false:失败)
"type":错误类型(pwd:用户密码不正确，userID:帐号不存在)

查看身边的设备，最多取100条数据

URL(示例)

http://api.coomix.net/GetDataService?method=draggableExperinceByRange

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
topRightLng true float 右上角的经度
topRightLat true float 右上角的纬度
bottomLeftLng true float 左下角的经度
bottomLeftLat true float 左下角的纬度
zoom true number 地图放大级别
showNum false number 显示的设备数量, 默认30
mapType false string 校准的地图类型(BAIDU_MAP/G_NORMAL_MAP/G_SATELLITE_MAP)，为空则默认为卫星地图(经纬度不校准)

返回结果

{
	key:{
		sys_time:0,
		user_name:1,
		jingdu:2,
		weidu:3,
		datetime:4,
		heart_time:5,
		su:6,
		status:7,
		hangxiang:8,
		sim_id:9,
		user_id:10,
		sale_type:11,
		iconType:12,
		server_time:13,
		product_type:14,
		expire_date:15,
		group_id:16
	},
	records:[
		["2012-03-12 15:25:58","d0","106.5562","29.47621",
		"2012-03-12 15:25:56","2012-03-12 15:25:58","3","410604",
		"272","35340","244129","0","22","2012-03-12 15:26:26","GT02","2012/03/20 15:26:26","0"],
		...
		["2012-03-12 15:26:19","d1","106.76822","29.618883",
		"2012-03-12 15:26:17","2012-03-12 15:26:19","4","410604",
		"252","35341","301119","0","21","2012-03-12 15:26:26","GT02","2012/03/20 15:26:26","0"]
		]
}

输出参数备注：

sys_time:系统时间
jingdu:经度
weidu:纬度
su:速度
hangxiang:航向，单位度
product_type:设备类型

查看单个用户(自己/好友)位置

URL

http://api.coomix.net/CmdService?method=getTerminalInfo

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
userID true number id(米号)
mapType false string 校准的地图类型(BAIDU_MAP/G_NORMAL_MAP/G_SATELLITE_MAP)，为空则默认为卫星地图(经纬度不校准)

返回结果

{
"jingdu":"113.95951",
"weidu":"22.538704",
"online":true,
"dl":"4",
"xhqd":"0",
"gpstiem":"2011-12-08 11:25:58",
"systime":"2011-12-08 11:30:03",
"heartime":"2011-12-08 11:28:59",
"gpscount":"0",
"msgcount":"0",
"sudu":"-1",
"xieyihao":"0.0",
"status":"0004040001"
}

输出参数备注：

"jingdu":经度,
"weidu":纬度,
"online":是否在线(true为在线),
"dl":电量(1~6),
"xhqd":信号强度,
"gpstiem":gps时间,
"systime":服务器系统时间,
"heartime":心跳时间,
"sudu":速度(-1表示基站定位，否则就是卫星定位),
"xieyihao":协议号,
"status":状态

根据LatLng返回地址

URL

http://api.coomix.net/ApiService?method=getAdressByLngLat

支持格式

文本

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
i true string(lng,lat) 经度和纬度用逗号分割
ekey false string 企业密钥
imei false string 终端Imei号
mapType false number 地图类型(G_SATELLITE_MAP:google卫星地图; G_NORMAL_MAP:google电子地图; BAIDU:百度地图)

返回结果

广东省深圳市南山区高新南六路.科技南十二路.伟易达研发大楼地下停车场(西南)约138米.伟易达研发大楼（深圳）(西南)约143米.

经纬度校准

URL

http://api.coomix.net/ApiService?method=adjust

支持格式

文本

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
q true string(lng,lat) 经度和纬度用逗号分割
ekey false string 企业密钥
imei false string 终端Imei号
mapType false string 地图类型(G_NORMAL_MAP:google电子地图; BAIDU:百度地图)

返回结果

114.43792,26.539639

轨迹回放接口

URL(示例)

http://api.coomix.net/GetHistoryLocationInfo?userID=6786&from=2011-10-11 00:00:00&to=2011-10-14 16:2:28&start=0&limit=50

支持格式

JSON

HTTP请求方式

GET

是否需要登录

false

请求参数

  必选 类型及范围 说明
userID true number 用户米号
mapType false string 校准的地图类型(BAIDU_MAP/G_NORMAL_MAP/G_SATELLITE_MAP)，为空则默认为卫星地图(经纬度不校准)

返回结果

输出参数备注：

"userID":用户米号,
"userName":用户名,
"online":是否在线,
"lat":纬度,
"lng":经度,
"status":用户类型

多基站多WIFI获取经纬度及中文地址接口

URL(示例)

http://api.coomix.net/ApiService?method=getPositionByMultiLbs&mapType=G_NORMAL_MAP&needAdjust=0&lbs=460,0;10365,7703,25;10365,7715,23;10365,7799,18;10365,7702,19;10365,7743,19;10365,8000,18;10365,8055,18 &wifi=0123456789ab,1;0123456789ab,2

支持格式

JSON

HTTP请求方式

GET

是否需要登录

false

请求参数

  必选 类型及范围 说明
userID false number 用户米号
mapType false number 地图类型(G_SATELLITE_MAP:google卫星地图; G_NORMAL_MAP:google电子地图; BAIDU:百度地图)
needAdjust false number 是否需要校正(0:否,1:是)
lbs true string 多基站信息,格式:(mcc,mnc;lac_1,cid_1,rssi_1;lac_2,cid_2,rssi_2;......)
wifi false string 多wifi信息,格式:(mac1,sign1;mac2,sign2;...........)
mac（MAC地址16进制表示）：（0123456789ab） sign(信号强度)
ekey false string 企业密钥
imei false string 终端Imei号

返回结果

{
"lng":122.1150198,
"lat":40.2591846,
"address":"*********"
}

输出参数备注：

"lng":经度,
"lat":纬度,
"address":地址

位置上报接口

URL(示例)

http://api.coomix.net/ApiService?method=collectLbsWifi&lbs=460,0;10365,7703,25;10365,7715,23;10365,7799,18;10365,7702,19;10365,7743,19;10365,8000,18;10365,8055,18&wifi=0123456789ab,1;0123456789ab,2&lnglat=112.234567,22.123456&accuracy=1&source=0&position_type=0

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
lbs true string 多基站信息,格式:(mcc,mnc;lac_1,cid_1,rssi_1;lac_2,cid_2,rssi_2;......)
wifi true string 
多wifi信息,格式:(mac1,sign1;mac2,sign2;...........)
mac（MAC地址16进制表示）：（0123456789ab） 
sign(信号强度)
lnglat true string 经纬度：格式（经度,纬度）
accuracy true string 精度
source true string 
信息来源(暂定2个): 
0: GPS
1: WIFI/LBS
position_type true string 
坐标类型(暂定2个): 
0: 原始经纬度
1: BAIDU(Baidu地图校正后的经纬度)

返回结果

输出参数备注：

查看所有(好友)位置

URL(示例)

http://api.coomix.net/GetUserService?method=getUserFriendMapMark

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
userId true number 米号/IMEI/帐号
mapType false string 校准的地图类型(BAIDU_MAP/G_NORMAL_MAP/G_SATELLITE_MAP)，为空则默认为卫星地图(经纬度不校准)
friendId false string 指定要查询的好友userID，以逗号分隔，例如friendId=111，2222，333，没有该参数默认返回所有好友位置

返回结果

{
	"sysTime":"2012/03/10 00:31:09",
	"values":[
["5288","5288","","0","0","86.00205","27.996283","F",
"2011/06/01 01:00:00","528","0","30","2012/04/26 20:54:49","3"],
...
["17893","abc12345abc","2","0","0","124.00428","26.996927","V",
"2010/05/10 14:59:04","abc12345abc","0","-2","2012/04/26 20:54:49","3"]
		],
	"key":{
		"userID":0,
		"sex":2,
		"sudu":11,
		"groupID":10,
		"userPic":3,
		"remark":9,
		"status":7,
		"lastTime":8,
		"userName":1,
		"lng":5,
		"lat":6,
		"online":4,
		"locatedTime":12,
		"accuracy":13		
	}
}

输出参数备注：

"userID":用户id
"sex":性别
"sudu":速度(-1表示基站定位)
"groupID":群组ID
"remark":好友备注
"status":设备类型
"lastTime":最后在线时间
"userName":还有昵称
"lng":经度
"lat":纬度
"online":在线否(true:在线 false:离线)
locatedTime： 定位时间
accuracy： 精度

搜索好友

URL(示例)

http://api.coomix.net/GetUserService?method=searchFriends

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
type false string 搜索类型(userID:按用户id，IMEI:按imei号，userName:按用户昵称，account:按帐号, all:搜索全部类型)为空则搜索全部类型
content true string 搜索关键字

返回结果

[
	{
		"userID":"16580",
		"userName":"16580",
		"userPic":"0",
		"sex":""
	},
	...
	{
		"userID":"17580",
		"userName":"5",
		userPic":"0",
		"sex":"2"
	}
]

输出参数备注：

"userID":用户id
"userName":用户昵称
"sex":性别

添加好友

URL(示例)

http://api.coomix.net/GetUserService?method=addFriend

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
friendID true string 添加好友的ID
key true string 登录成功时获取的key
groupID true string 添加到某个群组的群ID

返回结果

{
	"success":true,
	"userID":"57085",
	"userName":"57085",
	"sex":"2",
	"userPic":"0",
	"online":"0",
	"lng":"86.00205",
	"lat":"27.996283",
	"status":"GS503A",
	"lastTime":"2011/06/01 01:00:00",
	"sysTime":"2012/03/10 02:11:51",
	"remark":"57085",
	"sudu":"30"
}
或
{
	"success":false,
	"type":"double"
}

输出参数备注：

"success":添加成功与否
"userID":"添加的好友ID
"userName":添加的好友昵称
"sex":添加好友性别(1:女 2：男)
"online":是否在线(0:离线 1:在线)
"lng":经度
"lat":纬度
"status":设备类型
"lastTime":最后登录时间
"sysTime":系统时间
"remark":备注名称
"sudu":速度

好友请求列表(这个接口目前不存在)

URL

http://api.coomix.net/GetDataService?method=FriendReqList

支持格式

JSON

HTTP请求方式

GET

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
userId true string 米号/IMEI/帐号

返回结果

[
	{
		"id":11,
		"userId":58085,
		"userName":"用户昵称"
	},
	...
	{
		"id":12,
		"userId":58086,
		"userName":"用户昵称"
	}
]

输出参数备注：

id:消息id
"userId":请求的用户id
"userName":"请求用户昵称"

处理单个好友请求

URL(示例)

http://api.coomix.net/GetUserService?method=validateFriend

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
ID true string 请求ID
type true number(1,2) 处理方式(0:同意,1：忽略,2：拒绝)

返回结果

{
	"success":true,
	"ID":20
}

输出参数备注：

success:操作是否成功(返回true || false)
ID:请求的消息ID

获取用户好友及分组信息

URL(示例)

http://api.coomix.net/GetDataService?method=getGroupInfoValues

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

false

请求参数

  必选 类型及范围 说明
userID true string 米号/IMEI/帐号
mapType false string 校准的地图类型(BAIDU_MAP/G_NORMAL_MAP/G_SATELLITE_MAP)，为空则默认为卫星地图(经纬度不校准)

返回结果

[
	{
		"userID":0,
		"friendID":1,
		"friendName":2,
		"userPic":3,
		"online":4,
		"strLastTime":5,
		"friendMemo":6,
		"sysTime":7,
		"jingdu":8,
		"weidu":9,
		"status":10,
		"sudu":11,
		"account":12,
		"locatedTime": 13,
        "accuracy": 14
	},
	{
		"groupID":"0",
		"groupName":"我的米客",
		"friendList":[
			["126388","5288","5288","0","0","2011/06/01 01:00:00","528",
			"2012/03/10 02:29:07","86.00205","27.996283","F","30", 
			"account", "2012/04/26 20:54:49", "3"],
			...
			["126388","18499","kk","0","0","2010/05/08 18:50:49","kk",
			"2012/03/10 02:29:07","122.075","37.310863","V","-2", 
			"account", "2012/04/26 20:54:49", "3"]
	 ]
	},
	...
	{
		"groupID":"1",
		"groupName":"我的家人",
		"friendList":[
			["126388","58085","devigner","0","0","2011/06/01 01:00:00","devigner",
			"2012/03/10 02:29:07","86.00205","27.996283","K3537","30", 
			"account", "2012/04/26 20:54:49", "3"],
			...
			["126388","58085","devigner","0","0","2011/06/01 01:00:00","devigner",
			"2012/03/10 02:29:07","86.00205","27.996283","K3537","30", 
			"account", "2012/04/26 20:54:49", "3"]
		]
	}
]

输出参数备注：

"fId":好友id
"fName":好友昵称
"fMemo":好友备注名
"lateTime":好友最后定位时间
"online":好友是否上线
"sysTime":系统时间
"lat":纬度
"lng":经度
"type":设备类型
"speed":速度
gid:群组id
gname:群组名称
list：群组好友列表
locatedTime: 定位时间
accuracy： 精度

添加分组

URL(示例)

http://api.coomix.net/GetUserService?method=addGroup

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
groupName true string 群组名

返回结果

{
	"success":true,
	"id":121212
}

输出参数备注：

success:操作是否成功(返回true || false)
id:新添加的群组id

删除群组

URL(示例)

http://api.coomix.net/GetUserService?method=deleteGroup

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
groupID true string 群ID

返回结果

{
	"success":true
}

输出参数备注：

success:操作是否成功(返回true || false)

修改群组名称

URL(示例)

http://api.coomix.net/GetUserService?method=modifyGroup

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
groupID true string 群组id
groupName true string 新群组名称

返回结果

{
	"success":true
}
或
{
	"success":false,
	"type":"dobule"
}

输出参数备注：

success:操作是否成功(返回true || false)
gid:群组id
gname:新群组名称
type:dobule:组名重复

移动好友到其他分组

URL(示例)

http://api.coomix.net/GetUserService?method=updateFriendRel

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
friendID true string 好友米号
groupID true number 新分组id

返回结果

{
	"success":true
}

输出参数备注：

success:操作是否成功(返回true || false)

删除好友

URL(示例)

http://api.coomix.net/GetUserService?method=deleteFriend

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
friendID true string 好友米号
userID true string 用户ID

返回结果

{
	"success":true
}

输出参数备注：

success:删除好友操作是否成功(返回true || false)

修改个人信息

URL(示例)

http://api.coomix.net/GetUserService?method=modifyUserInfo

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
phoneNum true string 用户米号/IMEI/帐号
userName true string 欲更新的用户昵称

返回结果

{
	"success":true
}

输出参数备注：

success:操作是否成功(返回true || false)

修改密码(这个需要Session，未登录无法调用成功)

URL(示例)

http://api.coomix.net/GetDataService?method=modifyUserPwd

支持格式

JSON

HTTP请求方式

GET/POST

是否需要登录

true

请求参数

  必选 类型及范围 说明
key true string 登录成功时获取的key
oldPwd true string 原用户密码
newPwd true string 新用户密码
newPwd2 true string 重复新用户密码

返回结果

{
	"success":true
}

输出参数备注：

success:操作是否成功(返回true || false)

API文档

显示全部

  1. 登录接口
  2. 获取登录用户的好友列表接口
  3. 跟踪选择的设备接口
  4. 查看所有好友位置信息接口
  5. 轨迹回放接口
  6. 多基站获取经纬度及中文地址接口
  7. 获取我的位置接口