接口路径(新):http://api.okayapi.com/api/App/Common_Address/Choose
接口路径(旧):http://api.okayapi.com/?s=App.Common_Address.Choose
接口描述: 根据省份、城市、区县、乡镇、村庄,选择地址。选择时,优先以最具体的行政区为准,即:村庄最优先,省份最后。使用时,可依次从province_list中选择省份,从province里选择城市,从city里选择区域……
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
province_code | String | Optaion | 省份编码 | ||
city_code | String | Optaion | 城市编码 | ||
area_code | String | Optaion | 区县编码 | ||
street_code | String | Optaion | 乡镇编码 | ||
village_code | String | Optaion | 村庄编码 |
请求(第一个示例:从省份开始选择):
{OKAYAPI_API_HOST}/?s=App.Common_Address.Choose&province_code=11&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"province": {
"code": "11",
"name": "北京市",
"next": [
{
"code": "1101",
"name": "市辖区"
}
]
},
"city": null,
"area": null,
"street": null,
"village": null,
"province_list": [
{
"code": "11",
"name": "北京市"
},
{
"code": "12",
"name": "天津市"
},
// 略 ……
],
"full_address": "北京市"
},
"msg": "当前请求接口:App.Common_Address.Choose"
}
请求(第二个示例:最后定位到具体的村庄的返回结果):
{OKAYAPI_API_HOST}/?s=App.Common_Address.Choose&village_code=110101001010&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"province": {
"code": "11",
"name": "北京市",
"next": [
{
"code": "1101",
"name": "市辖区"
}
]
},
"city": {
"code": "1101",
"name": "市辖区",
"next": [
{
"code": "110101",
"name": "东城区"
},
{
"code": "110102",
"name": "西城区"
},
// 略 ……
]
},
"area": {
"code": "110101",
"name": "东城区",
"next": [
{
"code": "110101001",
"name": "东华门街道办事处"
},
{
"code": "110101002",
"name": "景山街道办事处"
},
// 略 ……
]
},
"street": {
"code": "110101001",
"name": "东华门街道办事处",
"next": [
{
"code": "110101001001",
"name": "多福巷社区居委会"
},
{
"code": "110101001002",
"name": "银闸社区居委会"
},
// 略 ……
]
},
"village": {
"code": "110101001010",
"name": "正义路社区居委会",
"next": [
]
},
"province_list": [
{
"code": "11",
"name": "北京市"
},
{
"code": "12",
"name": "天津市"
},
// 略 ……
],
"full_address": "北京市市辖区东城区东华门街道办事处正义路社区居委会"
},
"msg": "当前请求接口:App.Common_Address.Choose"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口(第一个示例:从省份开始选择):
$rs = OkayApiClient::request('App.Common_Address.Choose',array('province_code'=>'11'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[province] => Array
(
[code] => 11
[name] => 北京市
[next] => Array
(
[0] => Array
(
[code] => 1101
[name] => 市辖区
)
)
)
[city] =>
[area] =>
[street] =>
[village] =>
[province_list] => Array
(
[0] => Array ( [code] => 11 [name] => 北京市 )
[1] => Array ( [code] => 12 [name] => 天津市 )
[2] => Array ( [code] => 13 [name] => 河北省 )
//略
[32] => Array ( [code] => 81 [name] => 香港特别行政区 )
[33] => Array ( [code] => 82 [name] => 澳门特别行政区 )
)
[full_address] => 北京市
)
[msg] => 小白开放接口:App.Common_Address.Choose
)
*/
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口(第二个示例:最后定位到具体的村庄的返回结果)
$rs = OkayApiClient::request('App.Common_Address.Choose',array('village_code'=>'110101001010'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[province] => Array
(
[code] => 11
[name] => 北京市
[next] => Array
(
[0] => Array ( [code] => 1101 [name] => 市辖区 )
)
)
[city] => Array
(
[code] => 1101
[name] => 市辖区
[next] => Array
(
[0] => Array ( [code] => 110101 [name] => 东城区 )
//略
[15] => Array ( [code] => 110119 [name] => 延庆区 )
)
)
[area] => Array
(
[code] => 110101
[name] => 东城区
[next] => Array
(
[0] => Array ( [code] => 110101001 [name] => 东华门街道办事处 )
//略
[16] => Array ( [code] => 110101017 [name] => 永定门外街道办事处 )
)
)
[street] => Array
(
[code] => 110101001
[name] => 东华门街道办事处
[next] => Array
(
[0] => Array ( [code] => 110101001001 [name] => 多福巷社区居委会 )
//略
[11] => Array ( [code] => 110101001015 [name] => 王府井社区居委会 )
)
)
[village] => Array
(
[code] => 110101001010
[name] => 正义路社区居委会
[next] => Array ( )
)
[province_list] => Array
(
[0] => Array ( [code] => 11 [name] => 北京市 )
//略
[33] => Array ( [code] => 82 [name] => 澳门特别行政区 )
)
[full_address] => 北京市市辖区东城区东华门街道办事处正义路社区居委会
)
[msg] => 小白开放接口:App.Common_Address.Choose
)
*/
KEY | Type | Description |
---|---|---|
province | Object | 省份信息(若有) |
province.code | String | 省份编码 |
province.name | String | 省份名称 |
province.next | String | 省份下的城市列表 |
city | Object | 城市信息(若有) |
city.code | String | 城市编码 |
city.name | String | 城市名称 |
city.next | String | 城市下的区县列表 |
area | Object | 区县信息(若有) |
area.code | String | 区县编码 |
area.name | String | 区县名称 |
area.next | String | 区县下的乡镇列表 |
street | Object | 乡镇信息(若有) |
street.code | String | 乡镇编码 |
street.name | String | 乡镇名称 |
street.next | String | 乡镇下的村庄列表 |
village | Object | 村庄信息(若有) |
village.code | String | 村庄编码 |
village.name | String | 村庄名称 |
village.next | String | 下一级列表 |
province_list | Array | 全国省份列表(固定返回) |
province_list[].code | String | 省份编码 |
province_list[].name | String | 省份名称 |
full_address | String | 完整的地址,例如:北京市市辖区东城区东华门街道办事处正义路社区居委会 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Apr/23/2024 07:36:40