极海|GeoHey 极海数据可视化API

数据可视化API

用于对用户数据和GeoHey公共数据进行可视化。数据要在地图上展现，传统方式是依托软件平台把数据发布成某种形式的服务。GeoHey提供了一种更为便捷的方式，用户通过数据可视化API可以直接对已上传的用户数据或者GeoHey公共数据进行可视化，不同的数据可以任意形式任意顺序组合。目前数据可视化API支持的可视化方式有：单色渲染、分段渲染、单值渲染、密度渲染、气泡渲染、热度渲染。

API地址

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

请求方法

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

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

访问凭证

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

响应格式与错误代码

响应的一般格式为：

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

错误代码有：

响应代码	代码说明
0	正常响应，无错误
601	没有通过API访问认证
602	没有操作的权限
603	API调用达到限额
604	IP被禁用
605	Access Key被禁用
611	API调用的必要参数缺失
612	API调用参数不合法
701	数据不存在
706	操作失败

发送可视化请求

请求地址

请求参数：

参数名（粗体为必需参数）	参数说明
callback	定义用于浏览器跨域访问时的回调函数名，一般在浏览器应用中使用
configJson	数据可视化方式的配置文件（JSON格式）

configJson参数示例：

               
[
    {
        "dataUid": "1c514d0382bd474792a572d4b8c1ee6b",
        "dataType": "private",
        "vizConfig": {
            "type": "polygon-simple",
            "labelField": null,
            "labelFont": null,
            "labelSize": 12,
            "fillColor": "#00ff00",
            "fillOpacity": 0.8,
            "outlineColor": "#ffffff",
            "outlineOpacity": 0.8,
            "outlineWidth": 1
        }
    },
    {
        "dataUid": "5acd041b1f5e4866bd13af6a8ef6bec6",
        "dataType": "private",
        "vizConfig": {
            "type": "marker-simple"
            "labelField": null,
            "labelFont": null,
            "labelSize": 12,
            "markerColor": "#ff2900",
            "markerSize": 5,
            "markerOpacity": 0.8,
            "outlineColor": "#ffffff",
            "outlineWidth": 1,
            "outlineOpacity": 0.8
        }
    }
]

正确响应数据格式：

JSON对象格式，其中vizId表示配置成功的可视化id

正确响应数据示例：

               

{
    "code": 0,
    "data": {
        "vizId": "44b801235b4234cb1d68c956d823b71a"
    }
}

根据vizId访问可视化

请求地址

请求参数：无
正确响应数据格式：地图瓦片

identify

请求地址

请求参数：

参数名（粗体为必需参数）	参数说明
callback	定义用于浏览器跨域访问时的回调函数名，一般在浏览器应用中使用
dataList	identify的数据列表，JSON格式
geometry	用户identify的几何图形，JSON格式
returnAll	是否返回所有查询结果，默认为false。如果设置为false，则只返回第一个查询到记录的数据中的第一条记录；否则返回所有数据中查询到的记录。

dataList参数示例：

[
    {
        "uid": "394de52e65cc42daa5569b886fd21828",
        "type":"private"
    },{
        "uid":"realestate_trade_area",
        "type":"public"
    }
]

geometry参数示例：

               
[12917105.776662974,4812633.618395993,12918634.517228676,4814162.358961696]

正确响应数据格式：

JSON对象格式

正确响应数据示例：

               

{
    "code": 0,
    "data": [
        {
            "featureSet": {
                "features": [
                    {
                        "id": 292,
                        "geom": [
                            12918315.056086555,
                            4813782.126657082
                        ],
                        "attrs": {
                            "WGS(84)X": 116.0346954,
                            "Name": "窦店中心幼儿园芦村分园",
                            "id": 292,
                            "WGS(84)Y": 39.63752282,
                            "UID": "14a0c6b34076261bbbbd6387",
                            "TEL": null,
                            "Type": "教育培训;幼儿园",
                            "Address": "近郊015县道",
                            "the_geom": null,
                            "Y": 39.63882016,
                            "Province": "北京市",
                            "X": 116.0409199,
                            "City": "北京市"
                        }
                    }
                ],
                "fields": [
                    "id",
                    "Name",
                    "X",
                    "Y",
                    "WGS(84)X",
                    "WGS(84)Y",
                    "Type",
                    "Address",
                    "TEL",
                    "City",
                    "Province",
                    "UID"
                ],
                "geometryType": "Point"
            },
            "dataUid": "394de52e65cc42daa5569b886fd21828"
        }
    ]
}