正地理编码 API

将地址描述转换为经纬度坐标。

1 概述

提供正地理编码等接口。协议默认规格有：

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

2、字符串都为 UTF8 格式；

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

鉴权方式：

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

2 正地理编码接口

2.1请求参数

定位结果的获取，通过GET 请求下面的 URL :

https://api.newayz.com/location/scenario/v1/geocode?access_key={access_key}&address={address}&city={city}

查询 params 参数含义：

参数 类型 必填 说明 示例
access_key String 是 申请的应用 KEY，访问接口权限 无
address String 是 查询地址:1. 标准的结构化地址信息，如武汉市洪山区关山大道43 号【推荐，地址结构越完整，解析精度越高】2. 支持“路与路交叉口”描述方式，如宁波市北仑区小港街道泰山路与人民北路交叉口 武汉市洪山区关山大道43 号
city String 否 如果需要，请传入完整名称。如武汉市 武汉市

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

2.2返回参数

默认返回10条距离最近的地址信息。

返回参数如下：

参数 类型 说明
id String 随机生成定位请求的UUID
geoPoint String 地址经纬度
type String 当前场景的属性信息，例如："Entity"等
name String 地址层级对应的名称
code String 格式化地址层级对应的代码
address Address 结构化地址信息
relevance Number 相关度评分
distance Number 距离，单位米。（正地址解析返回0）

Address 字段如下：

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

Context 字段如下：

参数 类型 说明
code String 格式化地址层级对应的代码
name String 格式化地址层级对应的名称

示例：

https://api.newayz.com/location/scenario/v1/geocode?access_key=key&address=宁波市北仑区小港街道泰山路与人民北路交叉口

完整返回信息参数如下:

[
  {
    "id": "e6c0add8ac6719c6354aaea1",
    "geoPoint": "121.810076,29.900822",
    "type": "Entity",
    "name": "博地影秀城",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "购物;购物中心"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 403.41528,
    "distance": 0,
    "phone": "(0574)56806667,(0574)87227316"
  },
  {
    "id": "9780485695ae86dcd8eced0c",
    "geoPoint": "121.809977,29.900809",
    "type": "Entity",
    "name": "商管公司",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "公司企业;公司"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F7",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 400.95593,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "13792a2926ca394e9d9d68c0",
    "geoPoint": "121.810149,29.900148",
    "type": "Entity",
    "name": "鱼跃电竞酒店",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "酒店"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F2",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 400.22058,
    "distance": 0,
    "phone": "13967809188"
  },
  {
    "id": "a31af7a4fab3a941c51e5135",
    "geoPoint": "121.810219,29.901625",
    "type": "Entity",
    "name": "博地影秀城-北区",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "休闲娱乐;电影院"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 400.04538,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "41db1333935612ad21022051",
    "geoPoint": "121.810332,29.900097",
    "type": "Entity",
    "name": "静安医馆",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "医疗"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F6",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 399.31546,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "dd9574f61ae2d80b91114ccf",
    "geoPoint": "121.810278,29.901206",
    "type": "Entity",
    "name": "星空之家",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "公司企业;公司"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F5",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 398.58603,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "83b7aff0976563764c6d462a",
    "geoPoint": "121.810217,29.900063",
    "type": "Entity",
    "name": "艺教公园",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "旅游景点;公园"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F4",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 398.56516,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "3dc64add3be4d4a6d5b74ee7",
    "geoPoint": "121.809795,29.900654",
    "type": "Entity",
    "name": "博地影秀城-南区",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "休闲娱乐;电影院"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 398.56516,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "a8558e5386fd3a9afbdc85f6",
    "geoPoint": "121.811213,29.900974",
    "type": "Entity",
    "name": "公共厕所",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "生活服务;公共厕所"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F1",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 398.56516,
    "distance": 0,
    "phone": ""
  },
  {
    "id": "5c26c2ee3cf8f28a471a3261",
    "geoPoint": "121.810439,29.900536",
    "type": "Entity",
    "name": "博地影秀城-酒吧夜市",
    "code": "",
    "categories": [
      {
        "id": "",
        "name": "美食;其他"
      }
    ],
    "address": {
      "name": "浙江省宁波市北仑区大碶街道泰山路与人民北路交叉口博地影秀城F1",
      "context": [
        {
          "type": "province",
          "name": "浙江省",
          "code": "330000"
        },
        {
          "type": "city",
          "name": "宁波市",
          "code": "330200"
        },
        {
          "type": "district",
          "name": "北仑区",
          "code": "330206"
        },
        {
          "type": "township",
          "name": "大碶街道",
          "code": "330206004"
        }
      ]
    },
    "relevance": 398.13354,
    "distance": 0,
    "phone": "(0574)81613999,13291955999"
  }
]

2.3报错信息

错误参数说明

错误参数 说明
400 参数异常
401 API 密钥认证失败
403 Appkey 权限异常
429 请求次数超额
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 幢