开发 Web服务 API 开发指南 GeoHUB API文档 三方数据空间检索

三方数据空间检索接口 最后更新时间: 2024年07月25日

产品介绍

三方数据空间检索接口是一类 Web API 接口服务,针对用户在 GeoHUB数据中心 上传的数据,以 HTTP/HTTPS 形式封装多种数据搜索接口,其中包括关键字搜索、周边搜索、多边形搜索、属性筛选四种筛选机制。以下为调用该接口前的数据准备流程:

  1. 使用 API 前您需先 申请 Key,若无高德地图 API 账号需要先申请账号。
  2. 前往 GeoHUB数据中心 创建您的数据集,并且保存上线,获取数据集 ID。

适用场景

用户自行维护的点位/区块/轨迹等数据上传 GeoHUB数据中心 后,需要进行相关的空间/属性检索,以在前端实现灵活调用。

  1. 关键字搜索:通过数据属性中的关键字进行条件搜索,例如:肯德基、朝阳公园等。支持模糊搜索;
  2. 周边搜索:在用户传入经纬度坐标点附近,在设定的范围内,按照属性条件进行搜索;
  3. 多边形搜索:在多边形区域内进行搜索,按照属性条件进行搜索;
  4. 属性筛选:按照属性条件进行搜索。

使用限制

目前三方数据空间检索接口仅对企业开发者开放。

使用说明

1
第一步
申请 【Web服务API】密钥(Key)
2
第二步
拼接 HTTP 请求 URL,第一步申请的 Key 需作为必填参数一同发送
3
第三步
接收 HTTP 请求返回的数据(JSON 或 XML 格式),解析数据
如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8
成为开发者并创建 Key 

为了正常调用 Web 服务 API ,请先注册成为高德开放平台开发者,并申请 Web 服务的 key ,点击具体操作

请求参数

关键字搜索

请求示例

https://restapi.amap.com/rest/lbs/geohub/place/text?key=<用户的key>&dataset_id=<id1>&condition_type=0&keywords=<keyword1>|<keyword2>

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网 申请 Web 服务 API 类型 Key

必填

dataset_id

数据集ID

暂时仅支持单个数据集

必填

properties_field

属性字段

选择关键字所在的属性字段

例如:[属性1]|[属性2]|[属性3]

可选

所有属性字段

condition_type

条件类型

0: 包含

1:等于

可选

1: 等于

keywords

关键字

[string1]|[string2]|[string3]

所有字段类型均 parse 成 string

必填

offset

每页记录数据

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

整型

可选

1

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback 值是用户定义的函数名称,此参数只在 output=JSON 时有效

可选

多边形搜索

请求示例

https://restapi.amap.com/rest/lbs/geohub/place/polygon?key=<用户的key>&dataset_id=<id1>|<id2>&polygon=<coord1>|<coord2>

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网 申请 Web 服务 API 类型 Key

必填

dataset_id

数据集 ID

暂时仅支持单个数据集

必填

polygon

多边形区域

多个坐标对集合,坐标对用"|"分割。多边形为矩形时,可传入左上右下两顶点坐标对;其他情况下首尾坐标对需相同。

必填

properties

筛选条件

各属性类型支持的操作, JSON 数据, 示例:

{

    "relation": "and", // 各个属性间的或与操作, 可选and,&&,or,||

    "conditions": [{

        "field": "alias", // 属性名

        "operation": "like", // 逻辑操作, 可选equal,=,not_equal,<>,greater,>,greater_equal,>=,less,<,less_equal,<=,in,like_any,like,not_like

        "value": "别名" // 属性值

    }]

}

两层逻辑(age字段>1且<10)示例:

{

    "relation": "and",

    "conditions": [{

        "field": "age",

        "relation": "and",

        "conditions":[{

            "operation": ">",

            "value": 1

        },{

            "operation": "<",

            "value": 10

        }]

    }]

}

可选

offset

每页记录数据

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

整型

可选

1

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback 值是用户定义的函数名称,此参数只在 output=JSON 时有效

可选

周边搜索

请求示例

https://restapi.amap.com/rest/lbs/geohub/place/around?key=<用户的key>&dataset_id=<id1>&location=<coord1>&radius=<num>

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网 申请 Web 服务 API 类型 Key

必填

dataset_id

数据集ID

暂时仅支持单个数据集

必填

location

中心点位置

中心点经纬度坐标, 如: 120.165904,35.982862

必填

radius

半径

以中心点为圆心的距离半径(单位:m)

取值范围:(0,50000]

必填

properties

筛选条件

各属性类型支持的操作, JSON 数据, 示例:

{

    "relation": "and", // 各个属性间的或与操作, 可选and,&&,or,||

    "conditions": [{

        "field": "alias", // 属性名

        "operation": "like", // 逻辑操作, 可选equal,=,not_equal,<>,greater,>,greater_equal,>=,less,<,less_equal,<=,in,like_any,like,not_like

        "value": "别名" // 属性值

    }]

}

两层逻辑(age字段>1且<10)示例:

{

    "relation": "and",

    "conditions": [{

        "field": "age",

        "relation": "and",

        "conditions":[{

            "operation": ">",

            "value": 1

        },{

            "operation": "<",

            "value": 10

        }]

    }]

}

可选

offset

每页记录数据

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

整型

可选

1

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback 值是用户定义的函数名称,此参数只在 output=JSON 时有效

可选

属性筛选

请求示例

https://restapi.amap.com/rest/lbs/geohub/place/properties?key=<用户的key>&dataset_id=<id1>|<id2>

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

用户在高德地图官网 申请 Web 服务 API 类型 Key

必填

dataset_id

数据集ID

暂时仅支持单个数据集

必填

properties

筛选条件

各属性类型支持的操作, JSON 数据, 示例:

{

    "relation": "and", // 各个属性间的或与操作, 可选and,&&,or,||

    "conditions": [{

        "field": "alias", // 属性名

        "operation": "like", // 逻辑操作, 可选equal,=,not_equal,<>,greater,>,greater_equal,>=,less,<,less_equal,<=,in,like_any,like,not_like

        "value": "别名" // 属性值

    }]

}

两层逻辑(age字段>1且<10)示例:

{

    "relation": "and",

    "conditions": [{

        "field": "age",

        "relation": "and",

        "conditions":[{

            "operation": ">",

            "value": 1

        },{

            "operation": "<",

            "value": 10

        }]

    }]

}

必填

offset

每页记录数据

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

当前页数

整型

可选

1

sig

数字签名

数字签名获取和使用方法

可选

output

返回数据格式类型

可选值:JSON,XML

可选

JSON

callback

回调函数

callback 值是用户定义的函数名称,此参数只在 output=JSON 时有效

可选

返回结果(通用)

名称

类型

说明

status

string

本次 API 访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见 错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅 info 状态表

count

string

单次请求返回的实际 poi 点的个数

objects

object

符合关键字筛选条件的数据对象

geometry

coordinates

string,array

点对象(string):'39.23489, 127.32487'

线/面对象(array):

['39.23489, 127.32487', '39.23489, 

127.32487', '39.23489, 127.32487',

'39.23489, 127.32487', '39.23489,

127.32487', '39.23489, 127.32487']

type

string

point/polyline/polygon/multipoint/multipolyline/multipolygon

properties

property1

name

string

属性名称

value

string/number/boolean

属性值

property2

name

string

属性名称

value

string/number/boolean

属性值

...

...

...

...

返回顶部 示例中心 常见问题 智能客服 公众号
二维码