1.1 功能介绍

搜索服务API是一类简单的HTTP接口,可通过多种方式搜索POI信息,其中包括关键字搜索、周边搜索、多边形搜索、ID搜索、K码搜索、POI推荐六中筛选机制。

该套API免费对外开放,使用之前请先登录然后申请密钥获取使用该组API的key。

关键字搜索:通过用户输入查询POI的关键字进行条件搜索,例如:麦当劳、电影院等。

周边搜索:在指定位置周边范围内搜索相关信息。如传入指定城市,则仅在该城市搜索。

多边形搜索:根据用户的查询信息结合请求的多边形范围进行搜索,返回该范围内的搜索结果。

ID搜索:通过点击地图POI获取POIID后请求POI的详细信息;通过POI唯一ID获取POI详细信息。本API结合输入提示API使用。

K码搜索:输入凯立德K码返回该K码所在的位置信息。

POI推荐:根据请求的位置,判断当前城市并返回附近的热门POI。服务端可配置推荐的POI分类信息。 例如:酒店、餐馆、加油站等。

1.2 使用限制

企业开发者:单个key支持20万次/天,1万次/分钟调用。

个人开发者:单个key支持1000次/天,1000次/分钟调用。

服务地址:http://api.careland.com.cn/api/v1/search/keyword?param

param代表的参数包括必填参数和可选参数,所有参数均使用(&)进行分隔。各参数的使用说明请参照下表。

请求参数:

参数名称是否必填默认值格式举例说明
ak 用户key
xytype 0 坐标类型:
0为凯立德坐标系
2为国家加密坐标系
keyword 查询关键词
category 西餐厅|快餐
20050200|11010200
分类,多个分类及分类编码用|隔开 (分类编码提示参见分类提示接口)
city 默认为全国 city=北京
city=110000
查询城市
可输入城市名或行政区划分代码(adcode),指定此参数表示在指定的城市查询
bounds 116.218338,39.871279;
116.448364,39.967651
图面的左下右上点;当没有city时,用于确定请求城市(经纬度用“,分隔”,坐标间用“;”分隔)
center 中心点:用于距离计算
output json json 输出格式为json或者xml(目前暂不支持xml)
detail_level DETAIL_REGULAR 默认
DETAIL_REGULAR。 DETAIL_BRIEF:返回poi基础信息,如名称、地址等; DETAIL_REGULAR:增加返回poi其他信息,如团购信息、子poi信息等; DETAIL_VERBOSE:增加返回poi全量的深度信息,如小区的多边形等;
start 0 返回结果起始位置,默认为0。
count 10 返回结果数,默认为10。
callback 回调函数
callback值是用户定义的函数名称,此参数只在output=json时有效

请求示例:

http://api.careland.com.cn/api/v1/search/keyword?keyword=肯德基&city=北京&center=116.219559,39.842716&xytype=2&count=1&ak=<您的密匙>

返回结果示例:

{
  "errorCode": 0,
  "errorMessage": "ok",
  "count": 1,
  "pois": [
    {
      "id": "12202833",
      "name": "肯德基(杜家坎DT餐厅)",
      "address": "北京市丰台区杜家坎南路1-7",
      "haspcd": true,
      "pcd": {
        "adcode": 10106,
        "province": "",
        "city": "北京市",
        "district": "丰台区"
      },
      "tel_num": [],
      "hasxy": true,
      "xy": {
        "x": 116.208709,
        "y": 39.841868
      },
      "type_code": 11030200,
      "type_name": "肯德基",
      "road_id": 0,
      "distance": 930,
      "preferred": false,
      "shapes_flag": false,
      "hassubpois": false,
      "hasdeepinfo": false,
      "routingpointscount": 0,
      "hasshapes": false
    }
  ],
  "info": {
    "showMap": true,
    "bounds": [
      {
        "x": 116.208709,
        "y": 39.841868
      },
      {
        "x": 116.208709,
        "y": 39.841868
      }
    ]
  }
}

返回参数说明:

名称 类型 说明
errorCode String 错误代码
errorMessage String 错误描述
count String 返回记录数
pois Object[] 返回的POI信息(仅包含id,名称,地址,PCD信息及坐标),或其他信息(包括公交线路信息、地址信息或其他信息),非POI信息的判断标准为是否包含POIID
  id String 选填 POI ID
name String 选填 POI名称
pcd Object 返回结果所在的省市区
  adcode String 行政区划代码
province String 省、直辖市名称
city String 地市名称
district String 县区名称
address String 选填 地址信息
tel_num String 重复 电话信息
xy Object 选填 POI的经纬度坐标
  x String 经度乘以1000000
y String 纬度乘以1000000
type_code String POI 类型代码
type_name String POI 类型名称
road_id String 选填 道路ID
distance String 到指定点的距离
preferred boolean 是否推荐显示
shapes_flag String 是否有形状
sub_pois poi[] 重复 该POI包含的子POI信息
deep_info   列表页用到的深度信息
  rating String POI的用户综合评分,通常来自BD数据,例如携程、点评
price String 人均消费价格
tag String 个性标签,例如适合情侣用餐,提供WIFI等
has_group_buy boolean 是否有团购信息
restaurant_reservation boolean 是否可订餐
theater_reservation boolean 是否可订座
business_hour boolean 该POI的营业时间
book_button boolean 是否有预订按钮
book_name String 预订按钮的名字
book_url String 点击预订按钮跳转的url
activity String 活动信息,比如有几条团购,最低打几折,道路:路况,可带颜色,语法同price
has_wifi String 是否有wifi
can_park String 是否可停车
image String 主图片url
deep_type String 深度信息的类型
routing_points  

导航点

  x String 经度
y String 纬度
shapes String[] 重复 该POI的点、线、面数据描述线与面的点集,diff为当前点与上一点的差值。x_diff与y_diff必须一一对应
  base Object 必填 基准点经纬度坐标。
  x String 经度
y String 纬度
x_diff String 较上一个坐标点的经度差值。
x_diff String 较上一个坐标点的经度差值。
……    
y_diff String 较上一个坐标点的纬度差值
y_diff String  
……
deep_detail Object 详情页用到的深度信息(暂不提供)
info Object 其他信息,例如地图展现等
  show_map boolean 是否显示图面
bounds Object[] 建议的显示范围,返回左下、右上两个坐标值。
  x String 经度
y String 纬度

服务地址:http://api.careland.com.cn/api/v1/search/around?param

param代表的参数包括必填参数和可选参数,所有参数均使用(&)进行分隔。各参数的使用说明请参照下表。

请求参数:

参数名称是否必填默认值格式举例说明
ak 用户key
xytype 0 坐标类型:
0为凯立德坐标系
2为国家加密坐标系
keyword 查询关键词
category 西餐厅|快餐
20050200|11010200
分类,多个分类及分类编码用|隔开 (分类编码提示参见分类提示接口)
city 默认为全国 city=北京
city=110000
查询城市
可输入城市名或行政区划分代码(adcode),指定此参数表示在指定的城市查询
bounds 116.218338,39.871279;
116.448364,39.967651
图面的左下右上点;当没有city时,用于确定请求城市(经纬度用“,分隔”,坐标间用“;”分隔)
center 中心点:用于距离计算
range 1000米 range=500 以center为中心的搜索半径
output json json 输出格式为json或者xml(目前暂不支持xml)
detail_level DETAIL_REGULAR 默认
DETAIL_REGULAR。 DETAIL_BRIEF:返回poi基础信息,如名称、地址等; DETAIL_REGULAR:增加返回poi其他信息,如团购信息、子poi信息等; DETAIL_VERBOSE:增加返回poi全量的深度信息,如小区的多边形等;
start 0 返回结果起始位置,默认为0。
count 10 返回结果数,默认为10。
callback 回调函数
callback值是用户定义的函数名称,此参数只在output=json时有效

请求示例:

http://api.careland.com.cn/api/v1/search/around?city=北京&keyword=酒吧&center=116.308985,39.979637&range=4500&detail_level=DETAIL_VERBOSE&count=1&xytype=2&ak=<您的密匙>

返回结果示例:

{
  "errorCode": 0,
  "errorMessage": "ok",
  "count": 1,
  "pois": [
    {
      "id": "539764",
      "name": "新浪酒吧",
      "address": "北京市海淀区大地科技大厦附近",
      "haspcd": true,
      "pcd": {
        "adcode": 10108,
        "province": "",
        "city": "北京市",
        "district": "海淀区"
      },
      "tel_num": [],
      "hasxy": true,
      "xy": {
        "x": 116.304666,
        "y": 39.988641
      },
      "type_code": 13090000,
      "type_name": "酒吧",
      "road_id": 0,
      "distance": 1067,
      "preferred": false,
      "shapes_flag": false,
      "hassubpois": false,
      "hasdeepinfo": false,
      "routingpointscount": 0,
      "hasshapes": false
    }
  ],
  "info": {
    "showMap": true,
    "bounds": [
      {
        "x": 116.304666,
        "y": 39.988641
      },
      {
        "x": 116.304666,
        "y": 39.988641
      }
    ]
  }
}

返回参数说明:参见关键字搜索

服务地址:http://api.careland.com.cn/api/v1/search/polygon?param

param代表的参数包括必填参数和可选参数,所有参数均使用(&)进行分隔。各参数的使用说明请参照下表

请求参数:

参数名称是否必填默认值格式举例说明
ak 用户key
xytype 0 坐标类型:
0为凯立德坐标系
2为国家加密坐标系
keyword 查询关键词
category 西餐厅|快餐
20050200|11010200
分类,多个分类及分类编码用|隔开 (分类编码提示参见分类提示接口)
city 默认为全国 city=北京
city=110000
查询城市
可输入城市名或行政区划分代码(adcode),指定此参数表示在指定的城市查询
bounds 116.218338,39.871279;
116.448364,39.967651
图面的左下右上点;当没有city时,用于确定请求城市(经纬度用“,分隔”,坐标间用“;”分隔)
base 基准点经纬度坐标(同x_diff,y_diff构成多边形形状点)。
x_diff 较上一个坐标点的经度差值。
y_diff 较上一个坐标点的纬度差值。
output json json 输出格式为json或者xml(目前暂不支持xml)
detail_level DETAIL_REGULAR 默认
DETAIL_REGULAR。 DETAIL_BRIEF:返回poi基础信息,如名称、地址等; DETAIL_REGULAR:增加返回poi其他信息,如团购信息、子poi信息等; DETAIL_VERBOSE:增加返回poi全量的深度信息,如小区的多边形等;
start 0 返回结果起始位置,默认为0。
count 10 返回结果数,默认为10。
callback 回调函数
callback值是用户定义的函数名称,此参数只在output=json时有效

请求示例:

http://api.careland.com.cn/api/v1/search/polygon?keyword=肯德基&base=116.460988,40.006919&x_diff=0.021322&x_diff=-0.00715&x_diff=-0.002564&x_diff=-0.015906&x_diff=0.004298&y_diff=0.000462&y_diff=-0.010251&y_diff=-0.011903&y_diff=-0.000238&y_diff=0.02193&xytype=2&count=1&ak=<您的密匙>

返回结果示例:

{
  "errorCode": 0,
  "errorMessage": "ok",
  "count": 1,
  "pois": [
    {
      "id": "417517",
      "name": "肯德基(花家地餐厅)",
      "address": "北京市朝阳区花家地区1号商业楼",
      "haspcd": true,
      "pcd": {
        "adcode": 10105,
        "province": "",
        "city": "北京市",
        "district": "朝阳区"
      },
      "tel_num": [],
      "hasxy": true,
      "xy": {
        "x": 116.469135,
        "y": 39.985663
      },
      "type_code": 11030200,
      "type_name": "肯德基",
      "road_id": 0,
      "distance": 1067,
      "preferred": false,
      "shapes_flag": false,
      "hassubpois": false,
      "hasdeepinfo": false,
      "routingpointscount": 0,
      "hasshapes": false
    }
  ]
}

返回参数说明:参见关键字搜索

服务地址:http://api.careland.com.cn/api/v1/search/poiid?param

param代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

请求参数:

参数名称是否必填默认值格式举例说明
ak 用户key
xytype 0 坐标类型:
0为凯立德坐标系
2为国家加密坐标系
keyword poi唯一ID
output json json 输出格式为json或者xml(目前暂不支持xml)
callback 回调函数
callback值是用户定义的函数名称,此参数只在output=json时有效

请求示例:

http://api.careland.com.cn/api/v1/search/poiid?keyword=29069&xytype=2&ak=<您的密匙>

返回结果示例:

{
  "errorCode": 0,
  "errorMessage": "ok",
  "count": 1,
  "pois": [
    {
      "id": "29069",
      "name": "烔炀中心学校",
      "address": "安徽省合肥市巢湖市烔黄路",
      "haspcd": true,
      "pcd": {
        "adcode": 340181,
        "province": "安徽省",
        "city": "合肥市",
        "district": "巢湖市"
      },
      "tel_num": [],
      "hasxy": true,
      "xy": {
        "x": 117.634829,
        "y": 31.692141
      },
      "type_code": 15990000,
      "type_name": "其它文化教育设施",
      "road_id": 0,
      "distance": 0,
      "preferred": false,
      "shapes_flag": false,
      "hassubpois": false,
      "hasdeepinfo": false,
      "routingpointscount": 0,
      "hasshapes": false
    }
  ],
  "info": {
    "showMap": true,
    "bounds": []
  }
}

返回参数说明:参见关键字搜索

1.7 POI推荐

服务地址:http://api.careland.com.cn/api/v1/search/recommend?param

param代表的参数包括必填参数和可选参数,所有参数均使用(&)进行分隔。各参数的使用说明请参照下表。

请求参数:

参数名称是否必填默认值格式举例说明
ak 用户key
xytype 0 坐标类型:
0为凯立德坐标系
2为国家加密坐标系
city 默认为全国 city=北京
city=110000
查询城市
可输入城市名或行政区划分代码(adcode),指定此参数表示在指定的城市查询
center 116.472596,39.985227 用户当前位置
bounds 116.218338,39.871279;
116.448364,39.967651
图面的左下右上点;当没有city时,用于确定请求城市(经纬度用“,分隔”,坐标间用“;”分隔)
output json json 输出格式为json或者xml(目前暂不支持xml)
start 0 返回结果起始位置,默认为0。
count 10 返回结果数,默认为10。
callback 回调函数
callback值是用户定义的函数名称,此参数只在output=json时有效

请求示例:

http://api.careland.com.cn/api/v1/search/recommend?center=116.320648,39.923958&count=1&
xytype=2&ak=<您的密匙>

返回结果示例:

{
  "errorCode": 0,
  "errorMessage": "ok",
  "count": 1,
  "pois": [
    {
      "id": "29244545",
      "name": "西部盛鼎轩",
      "address": "",
      "haspcd": true,
      "pcd": {
        "adcode": 10108,
        "province": "",
        "city": "北京市",
        "district": "海淀区"
      },
      "tel_num": [],
      "hasxy": true,
      "xy": {
        "x": 116.321623,
        "y": 39.923966
      },
      "type_code": 11011100,
      "type_name": "清真菜",
      "road_id": 0,
      "distance": 83,
      "preferred": false,
      "routingpointscount": 0,
    }
  ],
  "info": {
    "showMap": true,
    "bounds": [
      {
        "x": 116.321623,
        "y": 39.923966
      },
      {
        "x": 116.321623,
        "y": 39.923966
      }
    ]
  }
}

返回参数说明:参见关键字搜索

 
版权所有 ©马蹄圈,并保留所有权利。
粤ICP备16121480号