导航API

用于路径分析与导航、可达区域分析。导航服务有很多实用场景,如运输行业的货物配送,根据途经点规划最优路线;服务行业根据店铺位置和周边交通情况确定服务区范围。

API地址

在开发过程中,可向该地址发送ajax请求获得分析结果;也可以使用GeoHey SDK指向该地址,获得分析结果。


请求方法

导航API支持GETPOST方法访问。在开发浏览器应用时,如果遇到GET方法不能满足要求的情况(如:受到GET请求长度的限制),可使用POST方法。GETPOST方法都支持使用回调(callback)。

访问凭证

API的访问凭证通过指定URL的参数ak指定,请求需要直接将ak参数附加于调用的URL上,如:http://geohey.com/s/routing/shortest?ak=...


响应格式与错误代码

响应的一般格式为:

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

错误代码有:

错误代码 代码说明
0 正常响应,无错误
601 没有通过API访问认证
602 没有操作的权限
603 API调用达到限额
604 IP被禁用
605 Access Key被禁用
611 API调用的必要参数缺失
701 导航服务不存在
706 查询失败或没有结果


  道路临近点

请求地址
请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
loc 需要计算道路临近点的坐标点,比如:[116.429724, 39.938647]
请求示例:
http://geohey.com/s/routing/nearest?loc=[116.569724, 39.938647]
正确响应数据格式:
{
    "code": 0,
    "data": {
        "name": "石各庄路",
        "loc": [
            116.56989288330078,
            39.94037628173828
        ]
    }
}
                                    


  最短路径分析

请求地址
请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
locs 用于计算最短路径分析的坐标点数组,例如:[[116.429724, 39.938647], [116.304159, 39.979345], [116.303909, 39.990687]]
returnPaths 是否获取最短路径节点序列, 默认为true
returnAlts 是否获取备选方案, 默认为false
returnSteps 是否获取最短路径导航指令集合, 默认为false
请求示例:
http://geohey.com/s/routing/shortest?locs=[[116.429724, 39.938647], [116.304159, 39.979345]]
正确响应数据格式:
{
    "code":<响应代码>,
    "data":
    {
        "summary": 
        {
            "start_point": <起始点>,
            "end_point": <终止点>,
            "total_time": <总耗时>,
            "total_distance": <总距离> 
        },
        "paths":[[X1, Y1], [X2, Y2], ..., [Xn, Yn]],
        "names":[, ..., ],
        "steps":
        [
            [<驾车方向>, <道路名称>, <前行距离>, <位置>, <前行时间(秒)>, <距离单位>, 
             <方向,N: north, S: south, E: east, W: west, NW: North>,
             <方位角>, <标识位>], 
             ..., 
             []
        ],
        "alt": <是否有备选方案>,
        "alt_summaries": [<类似summary>, ...],
        "alt_paths": [<类似paths>, ...],
        "alt_names": [<类似name>, ...],
        "alt_steps": [<类似steps>, ...]
    }
}

                                    


  驾驶时间内能到达的范围

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
loc 起始坐标点,比如:[116.429724, 39.938647]
time 驾驶时间,单位为分钟,默认为5分钟
请求示例:
http://geohey.com/s/routing/drivetime?loc=[116.404723,39.901224]&time=300
正确响应数据格式:
{
    "code": 0,
    "data": [
        [
            [
                116.36430678128292,
                39.89803389921948
            ],
            [
                116.36406914309718,
                39.898027537252304
            ]
            
            ......
            
            [
                116.36377584108853,
                39.89804851747879
            ],
            [
                116.36349226783487,
                39.898126314959434
            ],
            [
                116.3632293208973,
                39.89825793998067
            ]
        ]
    }
                                    


  驾驶距离内能到达的范围

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
loc 起始坐标点,比如:[116.429724, 39.938647]
distance 驾驶距离,单位为米,默认为5000米
请求示例:
http://geohey.com/s/routing/drivedis?loc=[116.404723,39.901224]&distance=5000
正确响应数据格式:
{
    "code": 0,
    "data": [
        [
            [
                116.36430678128292,
                39.89803389921948
            ],
            [
                116.36406914309718,
                39.898027537252304
            ]
            
            ......
            
            [
                116.36377584108853,
                39.89804851747879
            ],
            [
                116.36349226783487,
                39.898126314959434
            ],
            [
                116.3632293208973,
                39.89825793998067
            ]
        ]
    }
                                    


  公共交通通达性分析

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
loc 起始坐标点,比如:[116.429724, 39.938647]
time 乘车时间,单位为分钟,默认为30分钟,最大180分钟
请求示例:
http://geohey.com/s/routing/publictime?loc=[116.404723,39.901224]&time=30
正确响应数据格式:
{
    "code": 0,
    "data": [
        {
            x: 116.36430678128292,
            y: 39.89803389921948,
            time: 30
        },
        {
            x: 116.36406914309718,
            y: 39.898027537252304
            time: 25
        },
            
            ......
            
        {
            x: 116.36377584108853,
            y: 39.89804851747879,
            time: 20
        },
        {
            x: 116.36349226783487,
            y: 39.898126314959434,
            time: 15
        },
        {
            x: 116.3632293208973,
            y: 39.89825793998067,
            time: 10
        }
    ]
}