文档
测试

3.地址poi检索

POST
api_method:u-poi-search

接口描述

用户输入地址关键字,可返回可选地址

服务入口

测试环境:https://openapi-stg.huolala.cn/v1 正式环境:https://openapi.huolala.cn/v1

编码

数据编码: Accept:application/json Content-type: application/json 字符编码: utf-8

前端UI界面示例

![image.png](https://cos.easydoc.net/48578360/files/k93r409k)

公共请求参数

参数名
类型
描述
必填
api_method
string
接口方法
必填
api_version
string
接口版本,固定值:1.0
必填
app_key
string
应用app_key
必填
access_token
string
货拉拉账户授权访问令牌
必填
nonce_str
string
随机数,用户自定义,60s内不可重复使用,仅用于保证签名不可预测;示例:474
必填
timestamp
string
Unix时间戳(单位:秒),60s内有效,超过60s则超时;示例:1565225482
必填
signature
string
签名值
必填

应用级请求参数

参数名
类型
描述
必填
kw
string
搜索关键字 如:深圳北站
必填
city
string
搜索城市(中文名称), 如:深圳
可选
place_type
int
搜索类型 1-起点 2-终点 默认值0
可选
lat
double
定位纬度,gcj02坐标系(用于返回搜索结果时,返回与此经纬度的距离)
可选
lon
double
定位经度,gcj02坐标系(用于返回搜索结果时,返回与此经纬度的距离)
可选

响应参数

参数名
类型
描述
必填
ret
number
返回结果码
必填
msg
string
返回结果描述
必填
data
object
数据字典
必填
poi
array
数据列表
必填
place_id
string
标识ID,示例:6f6241e3c05ab1a093114c5e
必填
name
string
地址名称,示例:深圳北站
必填
addr
string
地址详情,示例:深圳市⻰华区致远中路28号
必填
city_name
string
地址所属城市名称, 示例:深圳市
必填
city_id
number
地址所属城市ID,示例:1002
必填
district_name
string
地址所属区(县),示例:⻰华区
必填
adcode
string
城市⾏政区(县)ID代码, 示例:440309
必填
distance
string
距离(将返回与输入参数中经纬度的距离,如果输入参数中没有传经纬度 则返回空)
必填
tag
string
示例:交通设施;⽕⻋站
必填
lat_lon
object
地址经纬度(gcj02坐标系)
必填
lon
double
定位经度,示例:114.02902185539
必填
lat
double
定位纬度,示例:22.609088515185
必填
children
array
子节点
必填
place_id
string
标识ID,示例:e81315bd5bad0965cb213d36
必填
name
string
子节点名称,示例:P1停⻋场
必填
addr
string
地址详情,示例:深圳北站-地下⼆层停⻋库
必填
adcode
string
城市⾏政区(县)ID代码, 示例:440309
必填
lat_lon
object
子节点地址经纬度(gcj02坐标系)
必填
lat
double
定位纬度,示例:22.60671945811
必填
lon
double
定位经度,示例:114.02730499903
必填

request Body请求示例

```json { "app_key":"*****************", "signature":"*******************", "nonce_str":"8sZD2c7raj", "timestamp":1564022849, "kw":"卓悦汇", "city": "深圳", "place_type":1, "lat":23.324232, "lon":113.232232 } ```

response响应示例

```json { "ret":0, "msg":"", "data":{ "poi":[ { "district_name":"⻰华区", "place_id":"6f6241e3c05ab1a093114c5e", "addr":"深圳市⻰华区致远中路28号", "name":"深圳北站", "distance":">100km", "city_name":"深圳市", "city_id":1002, "tag":"交通设施;⽕⻋站", "adcode":"440309", "lat_lon":{ "lat":22.609088515185, "lon":114.02902185539 }, "children":[ { "adcode":"440309", "addr":"深圳北站-地下⼆层停⻋库", "lat_lon":{ "lat":22.60671945811, "lon":114.02730499903 }, "name":"P1停⻋场", "place_id":"e81315bd5bad0965cb213d36" }, { "adcode":"440309", "addr":"深圳北站-A进站⼝", "lat_lon":{ "lat":22.606589151637, "lon":114.02717635139 }, "name":"A进站⼝", "place_id":"873349954e13423ff8dc851a" } ] }, { "district_name":"⻰华区", "place_id":"0f2c62b091be753e07026fea", "addr":"4号线;5号线", "distance":">100km", "city_name":"深圳市", "city_id":1002, "adcode":"440309", "children":[ ], "name":"深圳北站", "tag":"地铁站", "lat_lon":{ "lat":22.610727398272, "lon":114.03072621418 } } ] } } ```

返回状态码

|状态码|描述| |-|-|-| |0|成功| |1|服务器异常| |31001|搜索失败|