一、产品介绍
可部署至「本地服务器」或「专有云服务器」的WEB API服务，支持全国省市区查询服务，在专有网络环境下部署应用，保障数据私密性，提供一键启动软件部署包私有化方案。详情可点击: https://www.juhe.cn/papi/area 进行了解。
二、使用教程
下载部署包
- 通过聚合官方网站下载对应的MacOS版本私有部署包(*目前暂支持64位系统)，比如下载的压缩包版本为:
jxzqh-1.0.0-x86_64.tar.gz，将压缩包上传至服务器。 - 进入压缩包所在的文件目录，通过
tar命令解压，比如所在目录为:/data/download
# 进入目录
cd /data/download/
# 解压
tar zxvf jxzqh-1.0.0-x86_64.tar.gz
# 进入程序目录
cd jxzqh-1.0.0-x86_64
解压私有部署包后，进入程序目录，可以看到如下文件:
文件目录介绍:
-- data/xzqh_1.0.0.txt 为数据文件 (当然您也可以直接进行数据修改、更新或封装成其他程序服务)
-- docs/index.html 为接口调用基本说明文档
-- server 为服务主程序
启动API服务
1. 进入程序目录
cd jxzqh-1.0.0-x86_64
2. 启动服务
./server
3. 服务默认的端口为8369，如果该端口被占用或需自定义端口，启动时可以使用--port参数指定端口，例如:
./server --port 8368
4. 如需系统后台不挂断地运行，可以使用nohup命令启动服务，例如:
nohup ./server 2>&1 &
您也可以使用其他的比如supervisor等管理工具实现。
如启动结果如下图显示， 说明启动服务成功!
调用API服务
本地API服务启动成功后，您即可通过提供的API地址进行接口请求了。
比如上一步示例启动的服务 (具体服务的IP和端口以实际为准)，您可以通过:
接口文档地址
(浏览器访问,查看完整接口文档说明)
http://127.0.0.1:8369/docs
或
http://10.0.49.15:8369/docs
接口请求地址
API接口地址:
http://127.0.0.1:8369/query
或
http://10.0.49.15:8369/query
API接口参数简易参照 (GET请求接口，进行调用):
API接口请求参数示例:
# GET参数中fid的值即为需要查询的上级区域id，0为第一级
http://192.168.50.77:8369/query?fid=0
接口响应内容示例:
{
"code": 0,
"msg": "success",
"result": [
{
"id": "110000",
"name": "北京市",
"fid": "0",
"level_id": "1"
},
{
"id": "120000",
"name": "天津市",
"fid": "0",
"level_id": "1"
},
{
"id": "130000",
"name": "河北省",
"fid": "0",
"level_id": "1"
},
{
"id": "140000",
"name": "山西省",
"fid": "0",
"level_id": "1"
},
{
"id": "150000",
"name": "内蒙古自治区",
"fid": "0",
"level_id": "1"
},
{
"id": "210000",
"name": "辽宁省",
"fid": "0",
"level_id": "1"
},
{
"id": "220000",
"name": "吉林省",
"fid": "0",
"level_id": "1"
},
{
"id": "230000",
"name": "黑龙江省",
"fid": "0",
"level_id": "1"
},
{
"id": "310000",
"name": "上海市",
"fid": "0",
"level_id": "1"
},
{
"id": "320000",
"name": "江苏省",
"fid": "0",
"level_id": "1"
},
{
"id": "330000",
"name": "浙江省",
"fid": "0",
"level_id": "1"
},
{
"id": "340000",
"name": "安徽省",
"fid": "0",
"level_id": "1"
},
{
"id": "350000",
"name": "福建省",
"fid": "0",
"level_id": "1"
},
{
"id": "360000",
"name": "江西省",
"fid": "0",
"level_id": "1"
},
{
"id": "370000",
"name": "山东省",
"fid": "0",
"level_id": "1"
},
{
"id": "410000",
"name": "河南省",
"fid": "0",
"level_id": "1"
},
{
"id": "420000",
"name": "湖北省",
"fid": "0",
"level_id": "1"
},
{
"id": "430000",
"name": "湖南省",
"fid": "0",
"level_id": "1"
},
{
"id": "440000",
"name": "广东省",
"fid": "0",
"level_id": "1"
},
{
"id": "450000",
"name": "广西壮族自治区",
"fid": "0",
"level_id": "1"
},
{
"id": "460000",
"name": "海南省",
"fid": "0",
"level_id": "1"
},
{
"id": "500000",
"name": "重庆市",
"fid": "0",
"level_id": "1"
},
{
"id": "510000",
"name": "四川省",
"fid": "0",
"level_id": "1"
},
{
"id": "520000",
"name": "贵州省",
"fid": "0",
"level_id": "1"
},
{
"id": "530000",
"name": "云南省",
"fid": "0",
"level_id": "1"
},
{
"id": "540000",
"name": "西藏自治区",
"fid": "0",
"level_id": "1"
},
{
"id": "610000",
"name": "陕西省",
"fid": "0",
"level_id": "1"
},
{
"id": "620000",
"name": "甘肃省",
"fid": "0",
"level_id": "1"
},
{
"id": "630000",
"name": "青海省",
"fid": "0",
"level_id": "1"
},
{
"id": "640000",
"name": "宁夏回族自治区",
"fid": "0",
"level_id": "1"
},
{
"id": "650000",
"name": "新疆维吾尔自治区",
"fid": "0",
"level_id": "1"
},
{
"id": "710000",
"name": "台湾省",
"fid": "0",
"level_id": "1"
},
{
"id": "810000",
"name": "香港",
"fid": "0",
"level_id": "1"
},
{
"id": "820000",
"name": "澳门",
"fid": "0",
"level_id": "1"
},
{
"id": "990000",
"name": "苏鲁交界",
"fid": "0",
"level_id": "1"
}
]
}
*具体接口返回格式及说明，请参照接口文档
