当前位置:文档之家› Place API http接口使用说明

Place API http接口使用说明

PlaceAPI http 接口使用说明
1.1 Place API http 接口简介
Place API http 接口(以下简称http 接口)是一个供程序员调用的、http 形式的地图检索服务接口,且只向百度合作伙伴开放。

目前http 接口提供的功能包括:矩形区域关键字检索、周边区域关键字检索(也称:圆形区域检索)和城市内关键字检索。

http 接口主要服务那些非网页程序的调用,例如:C# 、C++、Java 等开发的应用程序,这些开发语言都能发送http 请求且能接收返回数据。

http 接口可以返回xml 和json 两种不同形式的的地理数据。

目前提供的功能不是很多、以后随着用户需求的收集和总结,会不断完善http 接口。

1.2 Place API http 接口使用说明
http 接口使用分为3个步骤:第一步,申请注册key ;第二步,拼写http 请求发送的url ,url 中附带上第一步申请的key 值;第三步,接收http 请求返回的数据(json 或xml 格式),如下图示意:
1.2.1申请注册key 说明
用户打开/wiki/static/mapws/placeapikey/页面,在此页面中申请注册key 值。

该key 主要目的是判断用户请求的url 是否合法,且限制用户1天发送的http 请求数不能超过1000次。

注册页面如下图:
填写好信息后,点击生成API密钥按钮就获取到所需的key值了,申请的key值和应用程序名称相关联,既相同的应用程序名称返回的key值是一样的。

特别注意:申请key之前会提示用户首先注册百度账号,只有拥有了百度账号,才能顺利的申请key值。

1.2.2 http接口请求参数说明
http接口请求参数主要包括:检索关键字、检索区域(3种选择形式)、输出结果类型(xml或json),如下表:
上表中,检索区域参数有3种形式可以指定,分别是:bounds、location+radius和region,请求的url中,这3种形式的检索区域参数必须指定一种。

如果3种形式的检索区域参数都指定了,优先选择bounds区域参数,其次是location+radius区域参数,最后是region区域参数。

对于query和region参数,因为这两个参数取值可以是中文或一些特殊字符(如:空格),举例:query可以取值“小吃”,region可以取值“北京”,为了避免提交到后台乱码,所以对于这2个参数值进行编码处理,编码成UTF-8 字符的二字符十六进制值。

query和region参数取值时候,凡是不在下表中的字符都要进行编码。

如果query和region参数中使用URL保留字字符的字面意思,例如:query关键字取值为“?小吃”,检索关键字包含了一个问号,此问号也必须进行编码,“?”的16进制编码为“%3F”,所以整个检索关键字“?小吃”编码后为“%3F%E5%B0%8F%E5%90%83”。

附注:
(1) javascript中一般采用encodeURIComponent函数对特殊字符进行编码。

(2) C#中可以使用函数URLEncoder.encode对特殊字符进行编码。

(3) Java中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。

(4) php中可以使用函数urlencode对特殊字符进行编码。

1.2.3 http接口返回数据说明
http接口返回数据如下表:
status字段取值有3种,分别是:
OK:成功
INVILID_KEY:非法密钥,用户没有使用key参数或key参数错误。

INVALID_PARAMETERS:非法参数,用户指定的query、(bounds;location+radius;region)、output参数有错误或缺少参数。

用户请求的参数正确,会返回20条满足条件的结果,如果检索条件区域内不足20条记录,那就输出实际检索到的记录数。

1.2.4 http接口示例
1.2.4.1 浏览器中使用示例
1 矩形区域检索(输出json数据):
/place/search?&query=%E9%93%B6%E8%A1%8C&bounds=39.915,116 .404,39.975,116.414&output=json&key=8cb976834235d8cbcde2dce4835ae191
2 周边区域检索(输出xml数据)
/place/search?&query=%E9%93%B6%E8%A1%8C&location=39.915,11 6.404&radius=2000&output=xml&key=8cb976834235d8cbcde2dce4835ae191
3 指定城市内检索(输出xml数据)
/place/search?&query=%E9%93%B6%E8%A1%8C&region=%E6%B5%8E %E5%8D%97&output=xml&key=8cb976834235d8cbcde2dce4835ae191
1.2.4.2 应用程序中使用示例1 Java中调用:
2 C#中调用:。

相关主题