地图API

用于定制和使用个性化地图。地图应用首先要考虑选择一幅怎样的地图做背景。除了选择主流在线地图,如果想要不一样,或让应用更具特色,或满足业务上对地图的特殊需求,地图API就派上用场了。

API地址

API地址大多用于在SDK中进行设置,由SDK帮助生成以下各种操作的请求地址并调用。Notes: {mappingUid}为地图的id号


请求方法

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

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


访问凭证

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


响应格式与错误代码

响应的一般格式为:

正确响应返回响应数据;
错误响应返回:                             
{
    "code":<错误代码>
}
                                

错误代码有:

错误代码 代码说明
601 没有通过API访问认证
602 没有操作的权限
603 API调用达到限额
604 IP被禁用
605 Access Key被禁用
611 API调用的必要参数缺失
701 对象不存在
702 参数不合法


获得瓦片图和标注

请求地址

请求参数:
参数名(粗体为必需参数) 参数说明
callback 定义用于浏览器跨域访问时的回调函数名,一般在浏览器应用中使用
z 请求图片对应的地图级别,例如取值1,表示请求地图第一级的瓦片图和其含有的标注
x 请求要求级别的地图中位于该行的图片,例如取值2,表示请求该级别地图中第二行中的瓦片图和其含有的标注
y 请求要求级别的地图中位于该列的图片,例如取值为3,表示请求该级别地图中第3列中的瓦片图和其含有的标注
retina 是否请求支持高清屏的切片,取值为"@2x"表示请求高清屏切片