接口文档

通信协议

目前支持HTTP、HTTPS 两种通讯方式

请求方法

请求接口:

POST http://lbs.baidubce.com

公共请求头

头域 类型 说明
Content-Type String 总是application/json; harset=utf-8
x-bce-request-id uuid 请求id 36位uuid(非必须)
x-bce-date String UTC时间 格式%YYYY-%mm-%ddT%HH:%MM:%SSZ eg 2018-02-22T09:47:52Z
x-app-id uuid 应用ID 在console上可见
Host String Http HEADER必须项
Authorization String 百度智能云统一认证字符串详情

公共响应头

所有的请求响应,需要包含如下的header信息

头域 类型 说明
x-bce-request-id uuid 对应请求的requestId
Content-Type String 总是application/json;charset=utf-8

接口定义

智能硬件定位

请求示例

HTTP_METHOD URI 说明
POST /locapi/v2 调用请求

请求例子:

curl -H "Content-Type:application/json" -H "x-bce-user-id: xxx..." -H "x-app-id: xxx..." -H "x-bce-date:2018-02-22T09:47:52Z" -H "Authorization:bce-auth-v1/xxx..." -d '{"key":"","src":"","prod":"","ver":"1.0","trace":false,"body":[{"accesstype":0,"imei":"xxx","smac":"","clientip":"","cdma":0,"imsi":"","gps":"","network":"GSM","tel":"xxx","bts":"xxx","mmac":"","macs":"xxx","coor":"GCJ02","output":"JSON","ctime":"1","need_rgc":"Y"}]}' http://lbs.baidubce.com/locapi/v2

请求参数

参数名 参数描述 参数类型 备注
src 定位请求来源,厂商标识,比如(baidu) string 必选
prod 产品线名称(baiduwatch) string 必选
ver 申请服务版本号,目前可用版本只有1.0 string 必选
trace 是否开启trace,若为true,则将定位记录到鹰眼(暂不开通) bool 必选
body 请求定位的设备信息 array 必选
+ accesstype 移动端接入网络方式
可选值:
移动接入网络:0
wifi接入网络:1
仅gps坐标转换:2
默认值:无
string 必选
+ imei 手机imei号
默认值:无
string 必选
+ smac 手机mac码
默认值:无
string 可选
+ clientip 移动网关IP
默认值:无
string 可选
+ cdma 是否为cdma
非cdma:0
cdma:1
默认值为:0
int accesstype=0时,必填
+ imsi 移动用户识别码
默认值:无
string 可选
+ gps 手机GPS数据
取值规则:
经度|纬度|半径
string accesstype=2时,必填
+ network 无线网络类型
GSM/GPRS/EDGE/HSUPA/HSDPA/WCDMA (注意大写)
string accesstype=0时,必填
+ tel 手机号码 string 可选
+ bts 基站信息
非CDMA格式为:mcc, mnc,lac,cellid,signal
CDMA格式为:sid,nid,bid,lon,lat,signal
其中lon,lat可为空,格式为:sid,nid,bid,,,signal
string accesstype=0时,必填
+ nearbts 周边基站信息
基站信息1|基站信息2|基站信息3…..
string 可选
+ mmac 已连热点mac信息
mac,signal,ssid
如:f0:7d:68:9e:7d:18,-41,TPLink
string 可选
+ macs wifi列表中mac信息
单mac信息同mmac,mac之间使用“|”分隔
string accesstype=1时,必填
+ coor 指定坐标系(GCJ02|BD09LL)注意大写
默认返回BD09LL坐标系
string 可选
+ output 返回数据格式类型(注意大写)
可选值:JSON, XML
默认值:JSON
目前只支持JSON
string 可选
+ ctime 客户端时间戳 string 必选
+ need_rgc 返回地址信息,默认不返回
Y : 返回rgc结果
N : 不返回rgc结果
string 可选

返回结果

返回结果参数(Json格式):

结果字段 含义 类型
errcode 返回结果状态,可参考错误码 int
msg 返回结果说明 string
body 定位响应信息,与请求信息对应 array
+ type 定位类型
0:没有得到定位结果;
1:gps 定位结果;
2:wifi定位结果;
3:混合定位 结果;
4:基站定位结果;
5:其他
int
+ location 定位经纬度(经度,纬度) string
+ radius 定位精度半径,单位:米 int
+ desc 位置描述 string
+ country 国家 string
+ province string
+ city string
+ citycode 城市编码 string
+ district 县区 string
+ road 道路名 string
+ ctime 客户端请求时间戳,批量请求时用于匹配 服务端响应和客户端请求 string
+ bldg 建筑物简称 string
+ bldgid 建筑物ID string
+ bldgname 建筑物 string
+ floor 楼层 string
+ indoor 是否室内:0:室外 1:室内 string
+ error 定位是否成功 0: 成功 -1:失败 int

错误码说明

错误码 错误描述
0 正常
101 Missing field : body (size should > 0 && < 3)
102 Request is empty
103 参数错误,错误详情请见“msg”字段
104 Unexpected err, please contact with us
601 Failed to authenticate for lack of AK
700 Failed to authenticate for invalid AK : ${key}(key校验失败)
710 Failed to authenticate for invalid IP : ${ip} (服务端IP校验失败)
740 Failed to authenticate for api loc is forbidden.(服务被禁用,一般不会出现)
752 Failed to authenticate for bad user.(非法用户)
760 Failed to authenticate for service is not exist(服务不存在,一般不会出现)
761 Failed to authenticate for service is off the assembly line(服务已下线,一般不会出现)
801 Failed to authenticate for exceeding total quota(总用量超限,一般不会出现)
802 Failed to authenticate for exceeding daily quota(${quota_num}) (日用量超限)
901 Failed to authenticate for exceeding concurrency(${min_quota}) (分钟并发超限)
902 Failed to authenticate for exceeding concurrency(${min_quota}) (日用量与分钟并发均超限)
其他500+错误 Failed to authenticate for unexpected error, please contact with us
750 Failed to authenticate for user is not exist
751 Failed to authenticate for user is deleted by yourself