天气查询 API
实时天气和天气预报查询接口。
1 概述
接口协议默认规格有:
1、时间戳为 int64,采用 unix 时间戳(Unix epoch),单位为毫秒;
2、字符串都为 UTF8 格式;
3、HTTP Headers:Content-Type 设置为:application/json
鉴权方式:
采用 access_key 的方式,在 URL 的 Query Param 中添加 access_key。
2 天气查询接口
输入城市编码和天气类型,查询实时或预报天气。
2.1请求参数
定位结果的获取,通过GET 请求下面的 URL :
旧地址:
https://api.newayz.com/maps/proxy/v1/weather?&access_key=your_access_key&city=420100&extensions=base
新地址:
https://api.newayz.com/location/scenario/v1/weather?&access_key=your_access_key&city =420100&extensions=base
新客户请用新地址访问,目前还兼容旧地址。
查询 params 参数含义:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access key _ | String | 是 | 申请的应用 KEY,访问接口权限 |
| city | Number | 是 | 城市编码,例如北京市城市编码是 110000 |
| extensions | String | 是 | 可选,base:实时天气,all: 预报天气 |
调用 WAYZ 的 API,需要提前获取 KEY 信息。
2.2返回参数
返回参数如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| status | String | 返回状态,值为0 或1;1:成功,0:失败 |
| count | String | 返回结果总数目 |
| info | String | 返回的状态信息 |
| infocode | String | 返回状态说明,10000 代表正确 |
| lives | Array<Live> | 实时天气信息数据 |
| forecasts | Forecast | 预报天气信息数据 |
Live 字段如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| province | String | 省份名 |
| city | String | 城市名 |
| adcode | String | 区域编码 |
| weather | String | 天气现象(汉字描述) |
| temperature | String | 实时气温,单位:摄氏度 |
| winddirection | String | 风向描述 |
| windpower | String | 风力级别,单位:级 |
| humidity | String | 空气湿度 |
| reporttime | String | 数据发布的时间 |
Forecast 字段如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| city | String | 城市名称 |
| adcode | String | 城市编码 |
| province | String | 省份名称 |
| reporttime | String | 预报发布时间 |
| casts | Cast | 预报数据list 结构,元素cast,按顺序为当天、 第二天、第三天的预报数据 |
Cast 字段如下:
| 参数 | 类型 | 说明 |
|---|---|---|
| date | String | 日期 |
| week | String | 星期几 |
| dayweather | String | 白天天气现象 |
| nightweather | String | 晚上天气现象 |
| daytemp | String | 白天温度 |
| nighttemp | String | 晚上温度 |
| daywind | String | 白天风向 |
| nightwind | String | 晚上风向 |
| daypower | String | 白天风力 |
| nightpower | String | 晚上风力 |
完整返回信息参数如下:
{
"status": "1",
"count": "1",
"info": "OK",
"infocode": "10000",
"lives": [
{
"province": "湖北",
"city": "武汉市",
"adcode": "420100",
"weather": "雾",
"temperature": "16",
"winddirection": "东北",
"windpower": "≤3",
"humidity": "79",
"reporttime": "2023-03-22 14:47:54"
}
],
"forecasts": [
{
"city": "武汉市",
"adcode": "420100",
"province": "湖北",
"reporttime": "2023-03-22 14:47:54",
"casts": [
{
"date": "2023-03-22",
"week": "3",
"dayweather": "小雨",
"nightweather": "多云",
"daytemp": "14",
"nighttemp": "14",
"daywind": "北",
"nightwind": "北",
"daypower": "≤3",
"nightpower": "≤3"
},
{
"date": "2023-03-23",
"week": "4",
"dayweather": "小雨",
"nightweather": "小雨",
"daytemp": "13",
"nighttemp": "9",
"daywind": "北",
"nightwind": "东北",
"daypower": "4",
"nightpower": "4"
},
{
"date": "2023-03-24",
"week": "5",
"dayweather": "小雨",
"nightweather": "晴",
"daytemp": "8",
"nighttemp": "7",
"daywind": "北",
"nightwind": "北",
"daypower": "≤3",
"nightpower": "≤3"
},
{
"date": "2023-03-25",
"week": "6",
"dayweather": "晴",
"nightweather": "小雨",
"daytemp": "14",
"nighttemp": "11",
"daywind": "北",
"nightwind": "北",
"daypower": "≤3",
"nightpower": "≤3"
}
]
}
]
}
2.3报错信息
| 错误参数 | 说明 |
|---|---|
| 400 | 参数异常 |
| 401 | API 密钥认证失败 |
| 403 | Appkey 权限异常 |
| 404 | 无法解析 |
| 429 | 请求次数超额 |
| 500 | 服务器异常 |
400 报错信息:
{
"code": "400",
"message": "no refdata provided"
}
401 报错信息:
{
"code": "401",
"message": "No API key found in request"
}
403 报错信息:
{
"code": "403",
"message": "Access key forbidden"
}
404 报错信息:
{
"code": "404",
"message": "scenario not found"
}
