YesApi 接口文档
接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，点击查看，或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构，其中：
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 | |
| province_code | 字符串 | 可选 | 省份编码 | ||
| city_code | 字符串 | 可选 | 城市编码 | ||
| area_code | 字符串 | 可选 | 区县编码 | ||
| street_code | 字符串 | 可选 | 乡镇编码 | ||
| village_code | 字符串 | 可选 | 村庄编码 |
在线测试
| 参数 | 是否必填 | 值 |
|---|---|---|
| s | 固定 | |
| uuid | 可选 | |
| token | 可选 | |
| return_data | 可选 | |
| yesapi_allow_origin | 可选 | |
| province_code | 可选 | |
| city_code | 可选 | |
| area_code | 可选 | |
| street_code | 可选 | |
| village_code | 可选 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。
# 【 3101 全国地址接口(支持级联)】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://api.yesapi.net/?s=App.Common_Address.Choose`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 根据省份、城市、区县、乡镇、村庄，选择地址。选择时，优先以最具体的行政区为准，即：村庄最优先，省份最后。使用时，可依次从province_list中选择省份，从province里选择城市，从city里选择区域……
- **返回格式**: JSON
## 请求参数说明
### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Common_Address.Choose` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中： 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。 静态签名，简单，固定的签名，点击获取。 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。 定制签名，支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |
### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| province_code | string | 可选 | 省份编码 |
| city_code | string | 可选 | 城市编码 |
| area_code | string | 可选 | 区县编码 |
| street_code | string | 可选 | 乡镇编码 |
| village_code | string | 可选 | 村庄编码 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.province | object | 省份信息（若有）|
| data.province.code | string | 省份编码|
| data.province.name | string | 省份名称|
| data.province.next | string | 省份下的城市列表|
| data.city | object | 城市信息（若有）|
| data.city.code | string | 城市编码|
| data.city.name | string | 城市名称|
| data.city.next | string | 城市下的区县列表|
| data.area | object | 区县信息（若有）|
| data.area.code | string | 区县编码|
| data.area.name | string | 区县名称|
| data.area.next | string | 区县下的乡镇列表|
| data.street | object | 乡镇信息（若有）|
| data.street.code | string | 乡镇编码|
| data.street.name | string | 乡镇名称|
| data.street.next | string | 乡镇下的村庄列表|
| data.village | object | 村庄信息（若有）|
| data.village.code | string | 村庄编码|
| data.village.name | string | 村庄名称|
| data.village.next | string | 下一级列表|
| data.province_list | array | 全国省份列表（固定返回）|
| data.province_list[].code | string | 省份编码|
| data.province_list[].name | string | 省份名称|
| data.full_address | string | 完整的地址，例如：北京市市辖区东城区东华门街道办事处正义路社区居委会|
## 请求示例
```bash
curl -X POST "http://api.yesapi.net/?s=App.Common_Address.Choose&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例：
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求：xxx参数错误"
}
```请求（第一个示例：从省份开始选择）：
{你的接口域名}/?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"
}
请求（第二个示例：最后定位到具体的村庄的返回结果）：
{你的接口域名}/?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
)
*/
接口返回
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。 |
| data.province | 对象 | 省份信息（若有） |
| data.province.code | 字符串 | 省份编码 |
| data.province.name | 字符串 | 省份名称 |
| data.province.next | 字符串 | 省份下的城市列表 |
| data.city | 对象 | 城市信息（若有） |
| data.city.code | 字符串 | 城市编码 |
| data.city.name | 字符串 | 城市名称 |
| data.city.next | 字符串 | 城市下的区县列表 |
| data.area | 对象 | 区县信息（若有） |
| data.area.code | 字符串 | 区县编码 |
| data.area.name | 字符串 | 区县名称 |
| data.area.next | 字符串 | 区县下的乡镇列表 |
| data.street | 对象 | 乡镇信息（若有） |
| data.street.code | 字符串 | 乡镇编码 |
| data.street.name | 字符串 | 乡镇名称 |
| data.street.next | 字符串 | 乡镇下的村庄列表 |
| data.village | 对象 | 村庄信息（若有） |
| data.village.code | 字符串 | 村庄编码 |
| data.village.name | 字符串 | 村庄名称 |
| data.village.next | 字符串 | 下一级列表 |
| data.province_list | 字符串 | 全国省份列表（固定返回） |
| data.province_list[].code | 字符串 | 省份编码 |
| data.province_list[].name | 字符串 | 省份名称 |
| data.full_address | 字符串 | 完整的地址，例如：北京市市辖区东城区东华门街道办事处正义路社区居委会 |
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳，例如：1657513450 |
| _auth | 字符串 | 反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单 |
异常错误码
| 错误码 | 错误类型 | 错误描述信息 | 解决方法 |
|---|---|---|---|
| ret = 200 | 成功 | 请求成功 | |
| ret = 400 | 客户端非法请求 | 表示客户端参数错误 | 1、根据接口文档的接口参数，提供正确的参数 |
| ret = 404 | 客户端非法请求 | 表示接口服务不存在 | 1、查看小白接口大全，确保接口服务名称拼写正确 |
| ret = 500 | 小白接口异常 | 表示服务端内部错误 | 1、进入QQ交流群897815708，反馈问题；2、或者提交工单，一天内回复 |
常见问题FAQ
Q1 问：出现 414 Request-URI Too Large 时怎么解决？答：对于全部参数，改用POST方式传递，并且从GET链接里面去掉。
Q2 问：浏览器请求和在线测试接口正常，但本地程序无法正常获取接口结果。答：需要注意UTF编码，以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求，POST表单数据正常传递即可。
Q3 问：请求接口时提示JSON格式错误。答：请先阅读，然后检测本地传递的参数是否符合JSON格式，使用JSON在线工具辅助检测，注意双引号和特殊符号。确认无误后再重新请求API接口。
Q4 问：出现 405 不允许跨域请求 时怎么办？答：可以追加GET参数 &yesapi_allow_origin=1，或参考用反向代理解决跨域问题等3种解决方案。
Q4 问：在wx内无法访问yesapi.cn或okayapi.com域名，怎么办？答：由于曾经短链跳转使用被wx误封域名，可以帮忙进行申诉。申诉后截图联系我们，获取15万次接口流量奖励。