接口文档

谷米云平台各接口介绍,及输入输出说明

1.参数编码

所有的请求和响应数据编码皆为utf-8格式,url里的所有参数值请做URIEncode编码;

各个参数请进行URL 编码(UTF-8),编码时请遵守 RFC 1738。

2.HTTP MIME类型

JSON
Content-type: text/html; charset=utf-8
JSONP
Content-type: text/javascript; charset=utf-8

3.通用参数

参数名 参数类型 是否必需 描述
appid string 您注册app时获得的appid
callback string 第三方通过JS调用Open API时可以通过指定callback参数来要求平台端返回JSONP代码,以解决跨域问题。callback参数值只能是字母数字下划线。



通用返回参数说明(json格式):

参数名 参数类型 描述
ret uint 当access_type!=inner时,错误码由ret返回,否则由errcode返回.
0: 正确返回
其它: 失败。错误码说明
msg string 如果ret不为0,会有相应的错误信息提示
errcode uint 参见ret描述
success bool 当access_type=inner时,为true表示成功,否则表示失败。
callback string 请求时所带的callback
接口说明
设备接入及位置信息上传
URL
http://open.goome.net/1/device/setloc?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
dev_id string 设备的唯一id,
比如可以是设备的imei号
gps_time number 定位时间 GPS定位时间 UTC 秒数
(如果只是更新设备状态,为0)
lng number 经度
(如果只是更新设备状态,可无)
lat number 纬度
(如果只是更新设备状态,可无)
course number 航向(正北方向为0度,顺时针方向增大。最大值360度)
(如果只是更新设备状态,可无)
speed number 速度 (单位:km/h)
(如果只是更新设备状态,可无)
tag1 string 用于标识设备的属性或状态。在找附近设备时可作为参数传入,以过滤想要的设备
tag2 string 用于标识设备的属性或状态。在找附近设备时可作为参数传入,以过滤想要的设备
tag3 string 用于标识设备的属性或状态。在找附近设备时可作为参数传入,以过滤想要的设备
请求示例
http://open.goome.net/1/device/setloc?appid=123&devid=4632434392&gps_time=1366786321
返回参数说明
参数名 参数类型 描述
sys_time number 系统收到Gps数据的时间 (UTC秒数)
正确返回示例
{
  "ret": 0,
  "msg": "",
  "sys_time": 1318409919
}
接口说明
获取设备最新位置信息
URL
http://open.goome.net/1/device/getloc?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
devid string 要监控的设备id列表,逗号分隔
map_type string 如果要显示在百度地图上,map_type=BAIDU此时返回的经纬度将经过baidu校准方式校准
如果要显示在google地图上,map_type=GOOGLE,此时返回的经纬度将经过google校准方式校准
map_type如果不填,则返回原始经纬度
请求示例
http://open.goome.net/1/device/getloc?appid=123&map_type=BAIDU&devid=1,2&account=testacc
返回参数说明
参数名 参数类型 描述
devid string 设备id
gps_time number 定位时间 GPS定位时间 UTC 秒数
(如果设备过期,值为0)
sys_ime number Gps数据的系统时间 UTC秒数
(如果设备过期,值为0)
heart_time number 心跳时间 UTC秒数
(如果设备过期,值为0)
server_time number 当前服务器时间 UTC秒数
(如果设备过期,值为0)
lng number 经度
(如果设备过期,值为0)
lat number 纬度
(如果设备过期,值为0)
course number 航向(正北方向为0度,顺时针方向增大。最大值360度)
(如果设备过期,值为0)
speed number 速度 (单位:km/h)
(如果设备过期,值为-1)
正确返回示例
{
  "ret": 0,
  "msg": "",
  "data": [
    {
      "devid": "1",
      "gps_time": 1318409927,
      "sys_time": 1318409919,
      "heart_time": 1318409919,
      "server_time": 1318428292,
      "lng": 113.91919,
      "lat": 22.54546,
      "course": 100,
      "speed": 80
    },
    {
      "devid": "2",
      "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
    }
  ]
}
接口说明
获取设备历史轨迹位置信息
URL
http://open.goome.net/1/devhis?
HTTP请求方式
GET
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
devid string 设备id
map_type string 如果要显示在百度地图上,map_type=BAIDU此时返回的经纬度将经过baidu校准方式校准
如果要显示在google地图上,map_type=GOOGLE,此时返回的经纬度将经过google校准方式校准
map_type如果不填/其他值,则返回原始经纬度
begin_time number 开始时间(UTC) 秒数
end_time number 结束时间(UTC) 秒数
limit number 1000 每次请求数据数量(一次最大1000条)
请求示例
http://open.goome.net/1/device/gethisloc?appid=123&devid=1&map_type=BAIDU
返回参数说明
参数名 参数类型 描述
gps_time number gps定位时间  UTC秒数
lng number 经度
lat number 纬度
course number 航向(正北方向为0度,顺时针方向增大。最大值360度)
speed number 速度,(单位: km/h)
正确返回示例
{
  "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
    }
  ]
}
接口说明
附近设备提取
URL
http://open.goome.net/1/device/getnearby?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
devid string 设备id
distance number 距离(米)
map_type string map_type=BAIDU 或map_type=GOOGLE
或不填则返回原始经纬度
tag1 string 过滤条件1
tag2 string 过滤条件2
tag3 string 过滤条件3
请求示例
http://open.goome.net/1/device/getnearby?appid=123&devid=1&distance=35&tag1=app1
返回参数说明
参数名 参数类型 描述
devid string 设备id(最多返回100个设备)
lng number 经度
lat number 纬度
正确返回示例
{
  "ret": 0,
  "msg": "",
  "data": [
    {
      "devid": "1",
      "lng": 113.91919,
      "lat": 22.54546
    },
    {
      "devid": "2",
      "lng": 113.91919,
      "lat": 22.54546
    }
  ]
}
接口说明
唯一id申请
URL
http://open.goome.net/1/uniqueid/get?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
         
请求示例
http://open.goome.net/1/uniqueid/get?appid=123
返回参数说明
参数名 参数类型 描述
id string 唯一id
正确返回示例
{
  "ret": 0,
  "msg": "",
  "id": "643728432"
}
接口说明
App自定义的Key-Value上传
URL
http://open.goome.net/1/kv/set?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
progid string App分配的标识进程的id
kvs string Key, Value;列表
请求示例
http://open.goome.net/1/kv/set?appid=123&kvs=key1,val1;key2,val2;key3,val3;
返回参数说明
参数名 参数类型 描述
     
正确返回示例
{
  "ret": 0,
  "msg": ""
}
接口说明
App自定义的Key-Value获取
URL
http://open.goome.net/1/kv/get?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
progid string App分配的标识进程的id
keys string Key列表
请求示例
http://open.goome.net/1/kv/get?appid=123&keys=key1,key2
返回参数说明
参数名 参数类型 描述
     
正确返回示例
{
  "ret": 0,
  "msg": "",
  "data": [
    {
      "key": "key1",
      "var": "var1"
    },
    {
      "key": "key2",
      "var": "var2"
    }
  ]
}
接口说明
根据经纬度得到中文地址
URL
http://open.goome.net/1/address/trans?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
lng number 经度
lat number 纬度
lang string 语言
简体中文=zh-cn
默认简体中文,目前仅支持简体中文
map_type string 用户根据上传的GPS经纬度校准,选用不同的map_type
map_type=BAIDU经纬度参数经过百度校准过
map_type=GOOGLE经纬度参数经过google校准过
非BAIDU ,GOOGLE表示原始经纬度,未经任何校准
请求示例
http://open.goome.net/1/address/trans?lng=114.342155&lat=30.682749&appid=123
表示请求经度为114.342155,纬度为30.682749的地址 (经纬度是原始值) http://open.goome.net/1/address/trans?lng=114.343088&lat=30.682888&appid=123&map_type=BAIDU
表示请求经度为114.343088,纬度为30.682888的地址 (经纬度不是原始值,该经纬度是经过了百度校准过的经纬度) http://open.goome.net/1/address/trans?lng=114.343231&lat=30.682345&appid=123&map_type=BAIDU
表示请求经度为114.343231,纬度为30.682345的地址 (经纬度不是原始值,该经纬度是经过了GOOGLE校准过的经纬度)
返回参数说明
参数名 参数类型 描述
ret uint 返回码
0: 正确返回
其它: 失败。错误码说明
msg string 如果ret不为0,会有相应的错误信息提示
address string 返回的地址信息
正确返回示例
{
  "ret": 0,
  "msg": "",
  "address": "湖北省武汉市堤边路.离新队约78米. "
}
错误返回示例
{"ret":20002,"msg":"缺失必选参数(lng),请参考API文档"}
接口说明
地图地址纠偏与反纠偏
URL
http://open.goome.net/1/map/adjust?
HTTP请求方式
GET/POST
输入参数说明

(1)通用参数

参见:通用参数

(2)私有参数

参数名 参数类型 是否必需 默认值 描述
lng number 经度
(如果只是更新设备状态,可无)
lat number 纬度
(如果只是更新设备状态,可无)
map_type string map_type=BAIDU 或map_type=GOOGLE,表示数据来源(direction=tostd),或目标(direction=tomap)
direction string direction=tostd或direction=tomap
配合map_type决定接口是校准还是反校准
请求示例
http://open.goome.net/1/map/adjust?appid=123&lng=113.91919&lat=22.54545&map_type=BAIDU&direction=tomap
返回参数说明
参数名 参数类型 描述
lng number 经度
lat number 纬度
正确返回示例
{
  "ret": 0,
  "msg": "",
  "data": [
    {
      "lng": 113.9305906,
      "lat": 22.54816858
    }
  ]
}