行政区划查询
<h2>概述</h2>
<p>根据输入关键词查询行政区划的相关信息，帮助用户快速查找特定的行政区域，包括行政区划的全称、经纬度、城市编码、区域编码等信息。支持全国省、市、区县、乡镇的分级查询，同时支持县级以上的邮政编码、区号、经纬度的查询</p>
<p>行政区划查询包括两个接口：区域查询、子区域查询</p>
<h2>区域查询</h2>
<h3>接口描述</h3>
<ul>
<li>查询某个级别下的区划信息</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/district/query</code></p>
<h3>请求方式</h3>
<ul>
<li>GET/POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h3>请求参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间戳</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名，详见签名算法说明</td>
</tr>
<tr>
<td>level</td>
<td>String</td>
<td>否</td>
<td>1-省，2-市，3-区县，4-乡镇，5-村委会</td>
</tr>
<tr>
<td>areaName</td>
<td>String</td>
<td>是</td>
<td>区域名称，尽量填完整的</td>
</tr>
<tr>
<td>page</td>
<td>Integer</td>
<td>否</td>
<td>当前页数, 分页时用, 最大50页,每页最大20条, 默认1</td>
</tr>
</tbody>
</table>
<p>> 传level时，必须和areaName对应</p>
<h3>签名算法说明</h3>
<p><code>sign = sha256(appId + appSecret + timestamp)</code></p>
<p>用服务商分配的 appId、服务商分配的 appSecret，当前时间时间戳 timestamp，按上述顺序拼接成字符串，再进行 sha256 哈希得到。如下：</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;；
String timestamp = &quot;1555378976238&quot;；
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;；
String str = appId + appSecret + timestamp；
String sign = sha256(str)；</code></pre>
<h3>成功返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200,
&quot;msg&quot;: &quot;成功&quot;,
&quot;taskNo&quot;: &quot;44993855847749695749&quot;,
&quot;charge&quot;: true,
&quot;data&quot;: {
&quot;details&quot;: [
{
&quot;provinceId&quot;: &quot;230000000000&quot;,//省级编码
&quot;simpleName&quot;: &quot;黑龙江&quot;,//区域名简称
&quot;lon&quot;: &quot;45.742347&quot;,//经度
&quot;lat&quot;: &quot;126.661669&quot;,//维度
&quot;cityId&quot;: &quot;&quot;,//市级编码
&quot;areaCode&quot;: &quot;0451&quot;,//区号
&quot;prePinYin&quot;: &quot;H&quot;,//拼音首字母
&quot;townId&quot;: &quot;&quot;,//乡镇id
&quot;id&quot;: &quot;230000000000&quot;,//区域id
&quot;pinYin&quot;: &quot;hei long jiang sheng&quot;,//区域名称的全拼
&quot;parentId&quot;: &quot;&quot;,//上级编码
&quot;villageId&quot;: &quot;&quot;,//村委id
&quot;level&quot;: 1,//区域级别 1 省级 2市级 3区县 4乡镇 5村委
&quot;areaName&quot;: &quot;黑龙江省&quot;,//区域名称
&quot;simplePy&quot;: &quot;HLJ&quot;,//简拼
&quot;zipCode&quot;: &quot;&quot;,//邮编
&quot;countyId&quot;: &quot;&quot;,//区县编码
&quot;wholeName&quot;: &quot;中国,黑龙江省&quot;//全称
}
],
&quot;total&quot;: 34,//总共多少条
&quot;pageSize&quot;: 20,//每页多少条
&quot;totalPage&quot;: 2 //总共多少页
}
}
</code></pre>
<h3>失败返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;区域名称不能为空!&quot;,
&quot;code&quot;: 400
}</code></pre>
<h3>返回字段说明</h3>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码，详见返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，详见成功返回样例</td>
</tr>
</tbody>
</table>
<h4>code返回码说明</h4>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功（计费）</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>请求地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>服务商维护，请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限，请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁，请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>
<h2>子区域查询</h2>
<h3>接口描述</h3>
<ul>
<li>查询子区域的网站名称、区域级别、区县编码、经纬度、简拼、邮编、区号、市政编码等数据</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/district/sub/query</code></p>
<h3>请求方式</h3>
<ul>
<li>GET/POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h3>请求参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间戳</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名，详见签名算法说明</td>
</tr>
<tr>
<td>parentId</td>
<td>String</td>
<td>是</td>
<td>上级的id, 该id可以在“区域查询”接口中查找</td>
</tr>
<tr>
<td>page</td>
<td>Integer</td>
<td>否</td>
<td>当前页数, 分页时用, 最大50页,每页最大20条, 默认1</td>
</tr>
</tbody>
</table>
<h3>签名算法说明</h3>
<p><code>sign = sha256(appId + appSecret + timestamp)</code></p>
<p>用服务商分配的 appId、服务商分配的 appSecret，当前时间时间戳 timestamp，按上述顺序拼接成字符串，再进行 sha256 哈希得到。如下：</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;；
String timestamp = &quot;1555378976238&quot;；
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;；
String str = appId + appSecret + timestamp；
String sign = sha256(str)；</code></pre>
<h3>成功返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200,
&quot;msg&quot;: &quot;成功&quot;,
&quot;taskNo&quot;: &quot;44993855847749695749&quot;,
&quot;charge&quot;: true,
&quot;data&quot;: {
&quot;details&quot;: [
{
&quot;provinceId&quot;: &quot;230000000000&quot;,//省级编码
&quot;simpleName&quot;: &quot;黑龙江&quot;,//区域名简称
&quot;lon&quot;: &quot;45.742347&quot;,//经度
&quot;lat&quot;: &quot;126.661669&quot;,//维度
&quot;cityId&quot;: &quot;&quot;,//市级编码
&quot;areaCode&quot;: &quot;0451&quot;,//区号
&quot;prePinYin&quot;: &quot;H&quot;,//拼音首字母
&quot;townId&quot;: &quot;&quot;,//乡镇id
&quot;id&quot;: &quot;230000000000&quot;,//区域id
&quot;pinYin&quot;: &quot;hei long jiang sheng&quot;,//区域名称的全拼
&quot;parentId&quot;: &quot;&quot;,//上级编码
&quot;villageId&quot;: &quot;&quot;,//村委id
&quot;level&quot;: 1,//区域级别 1 省级 2市级 3区县 4乡镇 5村委
&quot;areaName&quot;: &quot;黑龙江省&quot;,//区域名称
&quot;simplePy&quot;: &quot;HLJ&quot;,//简拼
&quot;zipCode&quot;: &quot;&quot;,//邮编
&quot;countyId&quot;: &quot;&quot;,//区县编码
&quot;wholeName&quot;: &quot;中国,黑龙江省&quot;//全称
}
],
&quot;total&quot;: 34,//总共多少条
&quot;pageSize&quot;: 20,//每页多少条
&quot;totalPage&quot;: 2 //总共多少页
}
}</code></pre>
<h3>失败返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;参数parentId不能为空!&quot;,
&quot;code&quot;: 400
}
</code></pre>
<h3>返回字段说明</h3>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码，详见返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，详见成功返回样例</td>
</tr>
</tbody>
</table>
<h3>code返回码说明</h3>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功（计费）</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>请求地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>服务商维护，请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限，请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁，请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>