行政区划查询接口

1.概述

中国行政区划查询接口 注意：城市信息中，针对省直管的县级市，会返回level为2和3两个结果，请取level为2的城市信息即可，例如湖北省仙桃市，会返回两个仙桃市信息，行政区划编码取level值为2的结果即可

2.接口基本信息

名称	描述
请求方式	POST
调用地址	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/tmc/trip/query/allAdminDivision 正式环境：https://bep-openapi.meituan.com/api/sqt/open/tmc/trip/query/allAdminDivision
调用方	客户平台
响应方	美团企业版
响应超时时间	3秒
调用限频	每分钟访问不超过100次，每天累计访问不超过100000次

2.1.请求体

名称	类型	是否必填	示例	说明
accessKey	String	是		美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值

content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
entId	Long	是	46574	企业ID

2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	56a0af18ae30a168d4006c7c	日志查询ID，用于排查问题
status	Integer	是	0	接口响应编码，编码枚举值和解决方案详见第四章错误码
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数

data解密后数据结构

类型	是否必填	示例	说明
List<AdminDivisionInfo>	否	见AdminDivisionInfo	返回结果

AdminDivisionInfo字段说明

名称	类型	是否必填	示例	说明
adCode	String	是	"110000"	行政区划编号
chineseName	String	是	"北京市"	行政区划中文名称
parentAdCode	Integer	否	null	父级行政区划编号
level	Integer	是	1	区划层级 行政区划层级（1：省级，2：市级，3：区县）

3.示例

3.1.请求示例

3.1.1.请求示例

{
  "accessKey":"B3KSWLDSKSKDMJ",
  "content":"UgxoCGPQIzoP"
}

3.1.2.请求参数content解析

{
  "ts": 123123,
  "entId": 100746
}

3.2.响应示例

3.2.1.响应结果

{
    "traceId":"56a0af18ae30a168d4006c7c",
    "status": 0,
    "data":"UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP"
}

3.2.2.响应参数data解析

[
    {
      "adCode":"110000",
      "chineseName":"北京市",
      "parentAdCode":null,
      "level":1
    },
    {
      "adCode":"110101",
      "chineseName":"东城区",
      "parentAdCode":110000,
      "level":3
    },
    {
      "adCode":"110102",
      "chineseName":"西城区",
      "parentAdCode":110000,
      "level":3
    }
]

4.错误码

4.1.公共错误码

错误码	错误描述	解决方案
10010002	企业已停止合作，请联系客户经理进行确认	将接口调用的entId参数给到客户经理，由客户经理确认企业状态是否在合作中
10010003	content不合法	详细阅读content参数加密说明（待补充），确认content加密方式和content解密前传参是否正确
10010004	ts缺失或ts时间已过期	确认ts是否传值并为13位时间戳，如果正确传值，则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟
10010005	entId不能为空	entId参数不可为空，如果未拿到entId参数，可以咨询客户经理获取
20010001	accessKey不合法	检查accessKey是否为客户经理给到的值，如果accessKey值正确，确认调用环境是否和accessKey一致，如使用测试环境的accessKey调用线上的接口
20010002	请求path不合法	检查接口调用地址是否正确，如是否有非法字符
20010003	鉴权失败，无接口访问权限	将接口调用地址给到客户经理，由客户经理检查接口权限是否开通并保存成功
20010004	越权访问，无法访问该企业数据，请检查entId的正确性	检查accessKey和entId两个参数的对应关系是否正确
30010001	访问频率过高	请确认接口访问频率，每个接口默认调用限频为每分钟不超过100次，超出调用频率会调用此错误
30010002	访问次数超过配额	请确认接口的累计访问次数，每个接口的默认累计调用量为10w次，超出限额则会报错

4.2.业务错误码

5.版本记录

版本号	版本日期	更新内容
v1.0	2022-10-28	新增中国行政区划查询接口