全国中学基础信息 API 数据接口

本文链接：https://blog.csdn.net/2301_82249201/article/details/137140595

全国中学基础信息 API 数据接口

基础数据，高校高考，提供全国初级高级中学基础数据，定时更新，多维度筛选。

gugudata_api_cover

1. 产品功能

2024 年数据已更新；
提供最新全国中学学校基本信息；
包含全国初级中学与高等中学；
总计近 10 万条全国中学精准数据；
每月一次数据自动更新校正；
包含学校各类属性信息；
毫秒级响应性能；
数据持续更新与维护；
全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
全面兼容 Apple ATS；
全国多节点 CDN 部署；
接口极速响应，多台服务器构建 API 接口负载均衡；
接口调用状态与状态监控

2. API 文档

接口详情: https://www.gugudata.com/api/details/middleschool

接口地址: https://api.gugudata.com/metadata/middle-school

返回格式: application/json; charset=utf-8

请求方式: GET

请求协议: HTTPS

请求示例: https://api.gugudata.com/metadata/middle-school?appkey={{APPKEY}}&pageIndex={{1}}&pageSize={{10}}&schoolType={{ALL}}&schoolName={{}}&provinceName={{}}&cityName={{}}

数据预览: https://www.gugudata.com/preview/middleschool

接口测试: https://api.gugudata.com/metadata/middle-school/demo

3. 请求参数

参数名	参数类型	是否必须	默认值	备注
appkey	string	是	APPKEY	付费后获取的 APPKEY
pageindex	int	是	1	页码，第几页数据
pagesize	int	是	10	每页数据量，参数最大值为 20
schooltype	string	否	ALL	中学类型：ALL (不限制) \| MIDDLE_SCHOOL (初级中学) \| HIGH_SCHOOL (高级中学)
schoolname	string	否		学校名称，模糊搜索，参数默认值为空，不进行筛选
provincename	string	否		学校所在省份，参数默认值为空，不进行筛选
cityname	string	否		学校所在城市，参数默认值为空，不进行筛选

4. 返回参数

参数名	参数类型	备注
RequestParameter	string	接口请求参数
DataStatus.StatusCode	int	接口返回状态码
DataStatus.StatusDescription	string	接口返回状态说明
DataStatus.ResponseDateTime	string	接口数据返回时间
DataStatus.DataTotalCount	int	此条件下的总数据量，一般用于分页计算
Data.Id	string	数据全局唯一 ID，仅用于标识数据的唯一
Data.SchoolName	string	中学学校名称
Data.SchoolType	string	中学类型
Data.Province	string	学校所在省份
Data.City	string	学校所在城市
Data.District	string	学校所在区县
Data.Address	string	学校地址
Data.PostalCode	string	学校邮政编码
Data.PhoneCode	string	学校电话区号

5. 接口 HTTP 响应标准状态码

状态码	状态码解释	备注
200	接口正常响应	业务状态码参见下方接口自定义状态码
403	请求频率超限	CDN 层通过 IP 请求频率智能判断，一般的高频请求不会触发此状态码

6. 接口响应状态码


自定义状态码	自定义状态码解释	备注
200	正常返回
400	参数错误
402	APPKEY 错误	请检查传递的 APPKEY 是否为开发者中心获取到的值
403	账号欠费	请及时关注订单到期短信提醒
429	请求频率受限	每秒请求不能超过 100 次
500	接口响应错误

7. 开发语言请求示例代码

示例代码包含的开发语言：C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等，其他语言进行对应的 RESTful API 请求实现即可。

code demo

8. 常见问题 Q&A

Q: 数据请求有缓存吗？

A: 所有的数据都是直接返回的，部分周期性数据在更新周期内数据是缓存的。
Q: 如何保证请求时 key 的安全性？

A: 一般建议将对我们 API 的请求放置在您应用的后端服务中发起，您应用的所有前端请求都应该指向您自己的后端服务，这样的架构也更加地纯粹且易维护。
Q: 接口可以用于哪些开发语言？

A: 可以使用于所有可以进行网络请求的开发语言，用于您项目快速地进行数据构建。
Q: 接口的性能可以保证吗？

A: 接口后台架构和我们给企业提供的商业项目架构一致，您可以通过访问测试接口查看接口相关返回性能与信息。