OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| school_name | String | Required | 需要搜索的大学名字，支持模糊匹配 | ||
| school_level | String | Optaion | 需要的学校类型，可以是：专科|本科 | ||
| school_province | String | Optaion | 需要的省份名称，如广东，北京，浙江等 | ||
| school_city | String | Optaion | 需要的城市名称，如广州，北京，深圳，上海等 | ||
| top_num | Int | Optaion | 10 | MIN: 1；MAX: 50 | 返回前面多少个匹配结果 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| school_name | *Required | |
| school_level | Option | |
| school_province | Option | |
| school_city | Option | |
| top_num | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| schools | Array | 搜索结果列表 |
| schools[].school_name | String | 大学名称 |
| schools[].school_province | String | 大学所在的省份 |
| schools[].school_level | String | 大学类型，专科|本科 |
| schools[].school_website | String | 大学官方网站 |
| schools[].school_city | String | 大学所在城市 |
HTTP Response Code
| HTTP Status Code | Description |
|---|---|
| Http Status = 200 | Success |
| Http Status = 400 | 表示客户端参数错误 |
| Http Status = 404 | 表示接口服务不存在 |
| Http Status = 500 | 表示服务端内部错误 |