POI 搜索 API

支持关键字搜索和周边搜索的兴趣点查询。

1 概述

提供融合定位等接口。协议默认规格有：

1、时间戳为int64，采用unix 时间戳（Unix epoch），单位为毫秒；

2、字符串都为UTF8 格式；

3、HTTP Headers：Content-Type 设置为：application/json

鉴权方式：

采用access_key 的方式，在URL 的Query Param 中添加access_key。

2 POI 搜索接口

2.1 关键字搜索

2.1.1请求参数

搜索结果的获取，通过GET 请求下面的URL :

https://api.newayz.com/location/scenario/v1/placesearch?name=小学&access_key=YOUR_KEY&city=武汉市&page_index=1&page_size=5

查询params 参数含义：

参数 类型 必填 说明
access_key string 是 申请的应用 KEY，访问接口权限
name string 是 关键字
city string 否 城市（需与城市编码必填一个）
city_code string 否 城市编码（需与城市必填一个）
page_index number 否 当前页数（第一页从1开始）
page_size number 否 每页的返回条数（默认返回10条，最大20）

调用 WAYZ 的 API，需要提前获取 KEY 信息。

2.1.2返回参数

返回参数如下：

参数 类型 必须 说明
id string 是 随机生成定位请求的 UUID
name string 是 地址层级对应的名称
code string 否 格式化地址层级对应的代码
type string 否 查询 POI 类型
distance number 否 距离,单位米
relevance number 否 相关度评分
geoPoint string 是 地址经纬度

Address 字段如下：

参数 类型 必须 说明
name string 是 当前定位地址的格式化全称
context Array<Context> 是 格式化地址的组成部分

Context 字段如下：

参数 类型 必须 说明
code string 否 格式化地址层级对应的代码
name string 是 格式化地址层级对应的名称
type string 否 格式化地址层级对应的类型，可能的值包括："Country"，"Province"，"City"，"District"，"Township"，"Road"

完整返回信息参数如下:

[
  {
    "id": "17ff52c28eae6197f7eafc04",
    "geoPoint": "113.940894,30.416141",
    "type": "Entity",
    "name": "永丰小学",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "教育培训;小学"
      }
    ],
    "address": {
      "name": "湖北省武汉市蔡甸区永安街道永桐永丰小学",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "蔡甸区",
          "code": "420114"
        },
        {
          "type": "township",
          "name": "永安街道",
          "code": "420114003"
        }
      ]
    },
    "relevance": 148.42671,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "f83d708caecd250c715e807f",
    "geoPoint": "113.762034,30.360999",
    "type": "Entity",
    "name": "小学旁",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "教育培训;小学"
      }
    ],
    "address": {
      "name": "湖北省武汉市蔡甸区消泗乡",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "蔡甸区",
          "code": "420114"
        },
        {
          "type": "township",
          "name": "消泗乡",
          "code": "420114200"
        }
      ]
    },
    "relevance": 145.8062,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "4ce10ce6d73121a1451a3284",
    "geoPoint": "113.996573,30.555453",
    "type": "Entity",
    "name": "蝙蝠小学",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "教育培训;小学"
      }
    ],
    "address": {
      "name": "湖北省武汉市蔡甸区张湾街道104省道",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "蔡甸区",
          "code": "420114"
        },
        {
          "type": "township",
          "name": "张湾街道",
          "code": "420114006"
        }
      ]
    },
    "relevance": 145.59927,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "253a88dfde4aaf19283a9fcc",
    "geoPoint": "114.395779,30.896723",
    "type": "Entity",
    "name": "曙光小学-东门",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "出入口;门"
      }
    ],
    "address": {
      "name": "湖北省武汉市黄陂区前川街道前王线曙光小学附近",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "黄陂区",
          "code": "420116"
        },
        {
          "type": "township",
          "name": "前川街道",
          "code": "420116001"
        }
      ]
    },
    "relevance": 137.82474,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "c4d84f7f6de21fb833169bb1",
    "geoPoint": "114.348127,30.161591",
    "type": "Entity",
    "name": "新建小学-东门",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "出入口;门"
      }
    ],
    "address": {
      "name": "湖北省武汉市江夏区乌龙泉街道乌龙泉街土地堂新建小学附近",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "江夏区",
          "code": "420115"
        },
        {
          "type": "township",
          "name": "乌龙泉街道",
          "code": "420115003"
        }
      ]
    },
    "relevance": 137.49513,
    "distance": 0,
    "phone": ""
  }
]

2.2 周边搜索

2.2.1请求参数

周边搜索结果的获取，通过GET 请求下面的URL :

https://api.newayz.com/location/scenario/v1/nearbysearch?access_key=YOUR_KEY&location=114.415673,30.504874&keywords=泛悦城&radius=200&page_index=1&page_size=5

查询params 参数含义：

参数 类型 必填 说明
access_key string 是 申请的应用 KEY，访问接口权限
location string 是 经纬度（默认坐标系：gcj02）
keywords string 否 关键字（可选）
radius string 是 周边半径（单位米，最大值20000）
category string 否 品类名称（品类表请联系管理员）
orderby string 否 按距离排序，请填写值: distance_score
page_index number 否 当前页数（第一页从1开始）
page_size number 否 每页的返回条数（默认返回10条，最大20）
2.2.2返回结果
[
  {
    "id": "0343f6b5d85b6a9ef942b2e1",
    "geoPoint": "114.413742,30.505327",
    "type": "Entity",
    "name": "奈雪的茶(泛悦城PRO店)",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "美食;其他"
      }
    ],
    "address": {
      "name": "湖北省武汉市洪山区关山街道关山大道泛悦城1层",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "洪山区",
          "code": "420111"
        },
        {
          "type": "township",
          "name": "关山街道",
          "code": "420111002"
        }
      ]
    },
    "relevance": 22.973486,
    "distance": 191.7347247905507,
    "phone": "13925240127,4008981577"
  },
  {
    "id": "7a9b8cefae08005cb1077dfa",
    "geoPoint": "114.413948,30.504932",
    "type": "Entity",
    "name": "唱吧麦颂KTV(泛悦城店)",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "休闲娱乐;ktv"
      }
    ],
    "address": {
      "name": "湖北省武汉市洪山区关山街道关山大道泛悦城1层",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "洪山区",
          "code": "420111"
        },
        {
          "type": "township",
          "name": "关山街道",
          "code": "420111002"
        }
      ]
    },
    "relevance": 22.835194,
    "distance": 165.38835509181183,
    "phone": "[\"15623597555\"]"
  },
  {
    "id": "6982cec6d9f40093bbdf8f7a",
    "geoPoint": "114.414160,30.505461",
    "type": "Entity",
    "name": "古茗(泛悦城店)",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "美食;其他"
      }
    ],
    "address": {
      "name": "湖北省武汉市洪山区关山街道关山大道泛悦城1层D1012号",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "洪山区",
          "code": "420111"
        },
        {
          "type": "township",
          "name": "关山街道",
          "code": "420111002"
        }
      ]
    },
    "relevance": 22.680151,
    "distance": 158.96992912483844,
    "phone": "15392904520"
  },
  {
    "id": "4e05046d3e5a9ca9d1f49ea4",
    "geoPoint": "114.413895,30.505399",
    "type": "Entity",
    "name": "UH祐禾(光谷泛悦城店)",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "美食;蛋糕甜品店"
      }
    ],
    "address": {
      "name": "湖北省武汉市洪山区关山街道关山大道泛悦城C栋1F",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "洪山区",
          "code": "420111"
        },
        {
          "type": "township",
          "name": "关山街道",
          "code": "420111002"
        }
      ]
    },
    "relevance": 22.620598,
    "distance": 180.0699135190036,
    "phone": "(027)88386488"
  },
  {
    "id": "aeda0ecf57a2c9d6d6b74e73",
    "geoPoint": "114.414160,30.505772",
    "type": "Entity",
    "name": "旺角卡门茶冰厅(光谷泛悦城店)",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "美食;小吃快餐店"
      }
    ],
    "address": {
      "name": "湖北省武汉市洪山区关山街道关山大道泛悦城一楼（茶颜悦色旁边）",
      "context": [
        {
          "type": "province",
          "name": "湖北省",
          "code": "420000"
        },
        {
          "type": "city",
          "name": "武汉市",
          "code": "420100"
        },
        {
          "type": "district",
          "name": "洪山区",
          "code": "420111"
        },
        {
          "type": "township",
          "name": "关山街道",
          "code": "420111002"
        }
      ]
    },
    "relevance": 22.489826,
    "distance": 176.01590016645753,
    "phone": "(027)87557688"
  }
]

2.3 报错信息

错误参数 说明
400 参数异常
401 Appkey非法或不存在
403 Appkey 权限异常
404 无法解析
529 请求次数超额
500 服务器异常

400 报错信息：

{
    "code": "400",
    "message": "no refdata provided"
}

401 报错信息：

{
    "code": "401",
    "message": "No API key found in request"
}

403 报错信息：

{

    "code": "403",
    "message": "Access key forbidden"
}

404 报错信息：

{
    "code": "404",
    "message": "scenario not found"
}

429 报错信息：

{
    "code": "429",
    "message": "API rate limit exceeded"
}

3 Address Model 级别说明

Level Field Type Description 示例说明
1 Country 国家 中国
2 Province/State 省 河北省、北京市
3 City 市 宁波市
4 District 区县 北京市朝阳区
5 Township 乡镇，街道 回龙观镇
6 Neighborhood 村庄，居委，乡 三元村
9 Road 道路 上海市浦东新区金科路
11 HouseNumber 门牌号 朝阳区阜通东大街6 号
13 Building 建筑 炬芯研发大楼A 幢