Place API http接口使用说明.docx

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格式），如下图示意：申请注册key拼写http请求url &key接收http返回 数据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）,如下表：参数是否必须默认值格式举例含义query(q)是无中关村、百度大厦检索关键字key是无8cb976834235d8cbcde2dce4835ae191用户申请注册的keybounds(bds)可选无38.76623,116.43213,39.54321,116.46773检索矩形区域location可选无38.76623,116.43213周边检索中心点radius(r) 可选无2000周边检索半径，单位米region可选无北京检索城市名称：可以是xxx市或xxx县，目前只支持市和县两种形式，像xx省、xx乡还不支持。output否xmljson 或 xml输出格式json或xml上表中，检索区域参数有3种形式可以指定，分别是：bounds、location+radius和region，请求的url中，这3种形式的检索区域参数必须指定一种。如果3种形式的检索区域参数都指定了，优先选择bounds区域参数，其次是location+radius区域参数，最后是region区域参数。对于query和region参数，因为这两个参数取值可以是中文或一些特殊字符（如：空格），举例：query可以取值“小吃”，region可以取值“北京”，为了避免提交到后台乱码，所以对于这2个参数值进行编码处理，编码成 UTF-8 字符的二字符十六进制值。 query和region参数取值时候，凡是不在下表中的字符都要进行编码。字符集合字符URL非保留字a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . URL保留字! * ( ) ; : & = + $ , / ? % # 如果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: OK, results: name: 名称, position: lat: 纬度:数值, lng: 经度:数值 , address: 地址, telephone: 电话, , more.status字段取值有3种，分别是：OK： 成功INVILID_KEY： 非法密钥，用户没有使用key参数或key参数错误。 INVALID_PARAMETERS： 非法参数，用户指定的query、(bounds；location+radius；region)、output参数有错误或缺少参数。用户请求的参数正确，会返回20条满足条件的结果，如果检索条件区域内不足20条记录，那就输出实际检索到的记录数。1.2.4 http接口示例 浏览器中使用示例1 矩形区域检索（输出json数据）：/place/search?&query=%E9%93%B6%E8%A1%8C&bounds=39.915,116.404,39.975,116.414&output=json&key=8cb976834235d8cbcde2dce4835ae1912 周边区域检索（输出xml数据）/place/search?&query=%E9%93%B6%E8%A1%8C&location=39.915,116.404&radius=2000&output=xml&key=8cb976834235d8cbcde2dce4835ae1913 指定城市内检索（输出xml数据）/place/search?&query=%E9%93%B6%E8%A1%8C®ion=%E6%B5%8E%E5%8D%97&output=xml&key=8cb976834235d8cbcde2dce4835ae19 应用程序中使用示例1 Java中调用：import java.util.List;import java.io.InputStreamReader;import .HttpURLConnection;import .URL;import .URLEncoder;import org.jdom.Document;import org.jdom.Element;import org.jdom.input.SAXBuilder;public class httpTest public static void main(String args) URL url = null;HttpURLConnection httpurlconnection = null;try String strChinese = URLEncoder.encode(银行, utf-8); /汉字编码为16进制 utf-8形式url = new URL(/place/search?query= + strChinese + &bounds=39.876804,116.125040,39.952953,116.682708&output=xml&key=8cb976834235d8cbcde2dce4835ae191);/ 以get方式请求httpurlconnection = (HttpURLConnection) url.openConnection();httpurlconnection.setDoOutput(true);httpurlconnection.setRequestMethod(GET);/ 获取到输入流InputStreamReader inputStreamReader = new InputStreamReader(httpurlconnection.getInputStream(), utf-8);/ 解析xmlSAXBuilder sax = new SAXBuilder();Document doc = sax.build(inputStreamReader);Element root = doc.getRootElement(); / PlaceSearchResponse节点Element eleResults = root.getChild(results);List lstRs = eleResults.getChildren(result);for (int i = 0; i lstRs.size(); i+) Element ele = (Element) lstRs.get(i);System.out.println(ele.getValue();System.out.println(n);System.out.println(共计: + lstRs.size() + 条记录!); catch (Exception e) e.printStackTrace(); finally if (httpurlconnection != null)httpurlconnection.disconnect();2 C#中调用：using System;using System.Collections.Generic;using System.Linq;using System.Text;using System.Xml;using System.Net;using System.Web;namespace httpTest class Program static void Main(string args) /此类在.net2.0下的system.web.dll中，需先添加该引用，具体操作如下： //c/2011/06/QYUVGI4I8GTWSQBP.asp string strChinese = HttpUtility.UrlEncode(餐厅);/编码成utf-8 16进制形式的汉字 /Console.WriteLine(strChinese); string strURL = /place/search?&query= + strChinese + &bounds=39.915,116.404,39.975,116.414&output=xml&key=8cb976834235d8cbcde2dce4835ae191; WebClient _client = new WebClient(); System.IO.Stream objStream = _client.OpenRead(strURL); System.IO.StreamReader _read = new System.IO.StreamReader(objStream, System.Text.Encoding.UTF8); XmlDocument xmlDoc = new XmlDocument(); xmlDoc.Load(_read); XmlNode statusNode = xmlDoc.SelectSingleNode(/PlaceSearchResponse/status); int count = 0;