地址匹配API

用来把地名地址转换成坐标。地址和坐标具有天然的对应关系,但是各种渠道获取的数据往往只有地址:信件的地址,快递的地址,注册会员的地址,客户的地址....实际业务场景需要了解这些地址的确切空间位置。

API地址

API地址大多用于在SDK中进行设置,由SDK帮助生成以下各种操作的请求地址并调用。


请求方法

API同时支持GETPOST方法访问,大多数情况建议使用POST方法;但是在基于浏览器直接调用的应用中,由于涉及跨域访问,所以只能采用GET方法请求,此时会受到GET请求长度的限制,在开发中需要注意。

如果开发浏览器应用时遇到GET方法不能满足要求的情况,需要在应用的同一域名下部署一个转发服务,将API的访问形式从浏览器直接调用转为服务器调用。


访问凭证

API的访问凭证通过指定URL的参数ak指定,无论是GET还是POST请求都需要直接将ak参数直接附加于调用的URL上,如:http://geohey.com/s/geocoding/decode?ak=...


响应格式与错误代码

响应的一般格式为:

{
    "code":<错误代码>,
    "data":<响应数据>
}
                                

错误代码有:

错误代码 代码说明
0 正常响应,无错误
601 没有通过API访问认证
602 没有操作的权限
603 API调用达到限额
604 IP被禁用
605 Access Key被禁用
611 API调用的必要参数缺失
612 API调用的参数不合法
800 地址服务调用异常


解析地址

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
addr 需要解析的地址,如"东直门外大街48 东方银座"
admin 帮助限定地址范围的行政区名称,如"北京", "北京 海淀", "北京市海淀区"
limit 最多返回的结果数目,取值范围为1到100,默认返回最匹配的1个结果
minSimilarity 返回结果至少满足的相似度,取值范围为0到100,默认50
请求示例:
http://geohey.com/s/geocoding/geocode?addr=东直门外大街48 东方银座
正确响应数据示例:
{
    code: 0,
    data:
    [
        {
            x: 116.435449
            y: 39.940042
            name: "东方银座"
            addr: "东直门外大街48"
            type: ""
            tel: "010-64168877"
        }
    ]
}
                                        

行政区划查询

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
name 需要查询的行政区划,如"江汉区", "武汉 江汉区"
parent 查询行政区划的父级行政区划,如"湖北", "湖北 武汉", "湖北省武汉市"
请求示例:
http://geohey.com/s/geocoding/admin?name=武汉市江汉区&parent=湖北
正确响应数据示例:
{  
    code: 0,
    data:
    {
        x: 114.259925
        y: 30.604776
        name: "江汉区"
        addr: "湖北省武汉市江汉区"
    }
}
                                        

邻近搜索

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
query 搜索的关键字,如"大学 东方银座"
x 搜索中心点得横坐标
y 搜索中心点得纵坐标
radius 搜索半径, 单位是米,取值范围0到10000, 默认值是100米
limit 最多返回的结果数目,取值范围为1到100,默认返回最匹配的1个结果
minSimilarity 返回结果至少满足的相似度,取值范围为0到100,默认10
请求示例:
http://geohey.com/s/geocoding/searchNear?query=大学&x=116.310015&y=39.991967&limit=5
正确响应数据示例:
{
    code: 0,
    data:
    [
        {
            x: 116.310015
            y: 39.991967
            name: "北京大学"
            addr: "颐和园路5号"
            type: ""
            tel: "010-62752114;010-62754046"
        },
        ... ...
    ]
}
                                        

框选范围搜索

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
query 搜索的关键字,如"大学 东方银座"
xmin 框选范围的横坐标最小值
ymin 框选范围的纵坐标最小值
xmax 框选范围的横坐标最大值
ymax 框选范围的纵坐标最大值
limit 最多返回的结果数目,取值范围为1到100,默认返回最匹配的1个结果
minSimilarity 返回结果至少满足的相似度,取值范围为0到100,默认10
请求示例:
http://geohey.com/s/geocoding/searchRect?query=大学&xmin=116.310001&ymin=39.991950&xmax=116.321632&ymax=39.996899&limit=5
正确响应数据示例:
{
    code: 0,
    data:
    [
        {
            x: 116.310015
            y: 39.991967
            name: "北京大学"
            addr: "颐和园路5号"
            type: ""
            tel: "010-62752114;010-62754046"
        },
        ... ...
    ]
}
                                        

电话号码查询

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
query 查询的手机或固定电话
请求示例:
http://geohey.com/s/geocoding/telephone?query=13888888888
正确响应数据示例:
{
    code: 0,
    data: {
        phone:13888888888,
        province:"云南",
        city:"昆明市",
        type:"移动全球通卡",
        lat:25.042907,
        lng:102.70818
    }
}