逐日预报API开发指南
基本信息
- 华风爱科 API提供给用户一个简洁的RESTful Web接口，用以访问基于位置的天气数据。
- 逐日预报搜索需location key配合。请使用定位API调取您所需要搜索的地点location key。
- 逐日预报可调取天数为1天，5天，10天。需要更长逐日预报请联系商务。
- 逐日预报支持中英文语言。如需要更多语言与本地化方言请联系商务。
- 逐日预报响应可返回公制与英制单位。默认返回英制单位，公制单位可在URL中添加metric=true以请求返回。
- API默认返回简短版逐日预报数据，信息包括：headline：数据有效期，Epoch数据有效期，严重程度，与文字。逐日报告信息：日期，Epoch日期，气温。白天：图标，图标文字，夜晚：图标，图标文字，mobile link与link。URL中添加details=true以请求详细版数据。
API服务地址
请求URL
| 类型 | URL | 请求方式 |
|---|---|---|
| 使用LocationKey调取1日预报 | https://openapi.weathercn.com/forecasts/{version}/daily/1day/{locationKey}{.{format}}?apikey=<用户的key>{&language={language code}}{&details={true or false}}{&metric={true or false}} | GET |
| 使用LocationKey调取5日预报 | https://openapi.weathercn.com/forecasts/{version}/daily/5day/{locationKey}{.{format}}?apikey=<用户的key>{&language={language code}}{&details={true or false}}{&metric={true or false}} | GET |
| 使用LocationKey调取10日预报 | https://openapi.weathercn.com/forecasts/{version}/daily/10day/{locationKey}{.{format}}?apikey=<用户的key>{&language={language code}}{&details={true or false}}{&metric={true or false}} | GET |
请求参数
| 参数 | 说明 | 默认值 | |
|---|---|---|---|
| apikey | 用以在API里验证与授权使用的用户密钥 | N/A | 必选 |
| version | 当前API版本 | v1 | 必选 |
| locationkey | 用以搜索指定地点的特定ID | N/A | 必选 |
| format | 响应格式 | JSON | 可选 |
| language | 指定响应数据语言的字符串 | zh-cn | 可选 |
| details | 用以判断是否返回简短版或完整版数据的布尔值（true 或 false），完整版 (details = true) | False | 可选 |
| metric | 用以判断是否返回公制或英制版版数据的布尔值（true 或 false），公制版 ( = true) | False | 可选 |
返回参数
| 参数 | 说明 | ||||
|---|---|---|---|---|---|
| Headline | 标题 | ||||
| EffectiveDate | 数据有效期的日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EffectiveEpochDate | 数据有效期的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Severity | Headline标题的严重性，数字越低越严重。严重性说明： 0：Unknown； 1：Significant； 2：Major； 3：Moderate； 4：Minor； 5：Minimal； 6：Insignificant； 7：Informational； | ||||
| Text | 标题文字 | ||||
| Category | 标题分类 | ||||
| EndDate | 标题周期终止的日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EndEpochDate | 标题周期终止的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| MobileLink | 跳转至的华风爱科/Accuweather移动端网页的链接 | ||||
| Link | 跳转至的华风爱科/Accuweather网页的链接 | ||||
| DailyForecasts | 逐日预报 | ||||
| Date | 当前预报日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EpochDate | 当前预报的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Sun | 太阳 | ||||
| Rise | 日出日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EpochRise | 日出的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Set | 日落日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EpochSet | 日落的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Moon | 月亮 | ||||
| Rise | 月出日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EpochRise | 月出的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Set | 月落日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm | ||||
| EpochSet | 月落的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT) | ||||
| Phase | 月相 | ||||
| Age | 距离上一次新月天数 | ||||
| Temperature | 气温 | ||||
| Minimum | 最小 | ||||
| Value | 气温取整数 | ||||
| Unit | 气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Maximum | 最大 | ||||
| Value | 气温取整数 | ||||
| Unit | 气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| RealFeelTemperature™ | AccuWeather RealFeel™ Temperature（专利） | ||||
| Minimum | 最小 | ||||
| Value | AccuWeather RealFeel™ Temperature 温度（专利）的气温取整数 | ||||
| Unit | RealFeel™气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Maximum | 最大 | ||||
| Value | AccuWeather RealFeel™ Temperature 温度（专利）的气温取整数 | ||||
| Unit | RealFeel™气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| RealFeelTemperatureShade™ | AccuWeather RealFeel™ Temperature in shade | ||||
| Minimum | 最小 | ||||
| Value | AccuWeather RealFeel™ Temperature （专利）的气温取整数 | ||||
| Unit | RealFeel™气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Maximum | 最大 | ||||
| Value | AccuWeather RealFeel™ Temperature （专利）的气温取整数 | ||||
| Unit | RealFeel™气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| HoursOfSun | 日照时长 | ||||
| DegreeDaySummary | 日度差信息摘要（中国地区暂不适用） | ||||
| Heating | 采暖日度差 | ||||
| Value | 平均温度低于65华氏度的总温度数值 | ||||
| Unit | 采暖日度差数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Cooling | 降温日度差 | ||||
| Value | 平均温度高出65华氏度的总温度数值 | ||||
| Unit | 降温日度差日气温数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| AirAndPollen | 空气与花粉（仅AirQuality的Value项中国区适用，为空气质量预报值；其他项中国地区暂不适用） | ||||
| Name | 污染物名称，例如：草、霉菌、空气质量、树木、紫外线指数等； | ||||
| Value | 以上污染物种类数值单位： 草、霉菌以及树木的数值为每立方含量； 空气质量与紫外线为指数，并无数值单位。 | ||||
| Category | 空气质量与污染种类，例如： low：低； high：高； good：优； moderate：良； unhealthy：不健康； hazardous：有害； | ||||
| CategoryValue | 与空气质量以及污染相关的分类数值，该数值范围为1到6，1则表示优良，6表示有害。 | ||||
| Type | 空气污染类型，例如臭氧与颗粒物污染 | ||||
| Day | 白天预报 | ||||
| Icon | 天气预报图标ID | ||||
| IconPhrase | 图标说明 | ||||
| ShortPhrase | 预报短句说明 (注: 华风爱科尝试将该短句控制在30字以内，但部分语言或天气情况的短句说明较长并且超过30字)。 | ||||
| LongPhrase | 预报长句说明 (注: 华风爱科尝试将该长句控制在100字以内，但部分语言或天气情况的长句说明较长并且超过100字)。 | ||||
| LocalSource | 针对特定数据的当地的数据源信息。如当地数据源信息缺失，该参数则不显示。 | ||||
| Id | 当地数据供应商ID值 | ||||
| Name | 当地数据供应商名称。在支持的情况下供应商名字将以请求的语言显示。否则名称将以英文或者该名称的本地语言显示。 | ||||
| WeatherCode | 本地数据供应商所提供的天气代码，需匹配WeatherCode编码表。 | ||||
| WindLevelCode | 本地数据供应商所提供的风力等级，需匹配WindLevelCode编码表。 | ||||
| WindDirectionCode | 本地数据供应商所提供的风向代码，需匹配WindDirectionCode编码表。 | ||||
| PubName | 发布机构 | ||||
| PubTime | 发布时间 | ||||
| EpochPubTime | 发布时间的UNIX时间 | ||||
| HasPrecipitation | 表示存在任何类型降水的布尔值。如果存在降水，则显示为真。（true or false） | ||||
| PrecipitationType | 降水类型， rain（雨）、snow（雪）、ice（冻雪）、mixed（雨夹雪）， 仅当HasRainforest为真时才返回。 | ||||
| PrecipitationIntensity | 降水强度， light（轻度）、moderate（中度）、heavy（重度）， 近当HasRainforest为真时才返回。 | ||||
| PrecipitationProbability | 降水概率(单位：%) | ||||
| ThunderstormProbability | 雷暴雨概率(单位：%) | ||||
| RainProbability | 降雨概率(单位：%) | ||||
| SnowProbability | 降雪概率(单位：%) | ||||
| IceProbability | 冻雪概率(单位：%) | ||||
| Wind | 风 | ||||
| Speed | 风速 | ||||
| Value | 风速取整数 | ||||
| Unit | 风速数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Direction | 风向 | ||||
| Degrees | 风向的方位角度(例：180°则是南风) | ||||
| Localized | 特定语言的风向缩写 | ||||
| English | 风向英文缩写 | ||||
| WindGust | 阵风 | ||||
| Speed | 风速 | ||||
| Value | 阵风风速取整数 | ||||
| Unit | 阵风风速数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Direction | 阵风风向 | ||||
| Degrees | 阵风风向的方位角度(例：180°则是南风) | ||||
| Localized | 特定语言的风向缩写 | ||||
| English | 风向英文缩写 | ||||
| TotalLiquid | 液体总量 | ||||
| Value | 总降水量取整数 | ||||
| Unit | 总降水数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Rain | 降雨 | ||||
| Value | 降雨取整数 | ||||
| Unit | 降雨数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Snow | 降雪 | ||||
| Value | 降雪取整数 | ||||
| Unit | 降雪数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Ice | 冻雪 | ||||
| Value | 冻雪取整数 | ||||
| Unit | 冻雪数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| HoursOfPrecipitation | 降水时长（小时） | ||||
| HoursOfRain | 降雨时长（小时） | ||||
| HoursOfSnow | 降雪时长（小时） | ||||
| HoursOfIce | 冻雪时长（小时） | ||||
| CloudCover | 云量 | ||||
| Evapotranspiration | 蒸发，土壤水分蒸发蒸腾损失总量。 | ||||
| Value | 蒸发取整数 | ||||
| Unit | 蒸发数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| SolarIrradiance | 太阳辐照度，在地球表面测量的太阳电磁辐射（全球水平辐照度）。 可以为空。 | ||||
| Value | 太阳辐照度取整数 | ||||
| Unit | 太阳辐照度数值的单位类型 单位：瓦特/平方米（W/㎡） | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Night | 夜间预报 | ||||
| Icon | 天气预报图标ID | ||||
| IconPhrase | 图标说明 | ||||
| ShortPhrase | 预报短句说明 (注: 华风爱科尝试将该短句控制在30字以内，但部分语言或天气情况的短句说明较长并且超过30字)。 | ||||
| LongPhrase | 预报长句说明 (注: 华风爱科尝试将该长句控制在100字以内，但部分语言或天气情况的长句说明较长并且超过100字)。 | ||||
| LocalSource | 针对特定数据的当地的数据源信息。如当地数据源信息缺失，该参数则不显示。 | ||||
| Id | 当地数据供应商ID值 | ||||
| Name | 当地数据供应商名称。在支持的情况下供应商名字将以请求的语言显示。否则名称将以英文或者该名称的本地语言显示。 | ||||
| WeatherCode | 本地数据供应商所提供的天气代码，需匹配WeatherCode编码表。 | ||||
| WindLevelCode | 本地数据供应商所提供的风力等级，需匹配WindLevelCode编码表。 | ||||
| WindDirectionCode | 本地数据供应商所提供的风向代码，需匹配WindDirectionCode编码表。 | ||||
| PubName | 发布机构 | ||||
| PubTime | 发布时间 | ||||
| EpochPubTime | 发布时间的UNIX时间 | ||||
| HasPrecipitation | 表示存在任何类型降水的布尔值。如果存在降水，则显示为真。（true or false） | ||||
| PrecipitationType | 降水类型， rain（雨）、snow（雪）、ice（冻雪）、mixed（雨夹雪）， 仅当HasRainforest为真时才返回。 | ||||
| PrecipitationIntensity | 降水强度， light（轻度）、moderate（中度）、heavy（重度）， 近当HasRainforest为真时才返回。 | ||||
| PrecipitationProbability | 降水概率(单位：%) | ||||
| ThunderstormProbability | 雷暴雨概率(单位：%) | ||||
| RainProbability | 降雨概率(单位：%) | ||||
| SnowProbability | 降雪概率(单位：%) | ||||
| IceProbability | 冻雪概率(单位：%) | ||||
| Wind | 风 | ||||
| Speed | 风速 | ||||
| Value | 风速取整数 | ||||
| Unit | 风速数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Direction | 风向 | ||||
| Degrees | 风向的方位角度(例：180°则是南风) | ||||
| Localized | 特定语言的风向缩写 | ||||
| English | 风向英文缩写 | ||||
| WindGust | 阵风 | ||||
| Speed | 风速 | ||||
| Value | 阵风风速取整数 | ||||
| Unit | 阵风风速数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Direction | 阵风风向 | ||||
| Degrees | 阵风风向的方位角度(例：180°则是南风) | ||||
| Localized | 特定语言的风向缩写 | ||||
| English | 风向英文缩写 | ||||
| TotalLiquid | 液体总量 | ||||
| Value | 总降水量取整数 | ||||
| Unit | 总降水数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Rain | 降雨 | ||||
| Value | 降雨取整数 | ||||
| Unit | 降雨数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Snow | 降雪 | ||||
| Value | 降雪取整数 | ||||
| Unit | 降雪数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Ice | 冻雪 | ||||
| Value | 冻雪取整数 | ||||
| Unit | 冻雪数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| HoursOfPrecipitation | 降水时长（小时） | ||||
| HoursOfRain | 降雨时长（小时） | ||||
| HoursOfSnow | 降雪时长（小时） | ||||
| HoursOfIce | 冻雪时长（小时） | ||||
| CloudCover | 云量 | ||||
| Evapotranspiration | 蒸发，土壤水分蒸发蒸腾损失总量。 | ||||
| Value | 蒸发取整数 | ||||
| Unit | 蒸发数值的单位类型 | ||||
| UnitType | 用于单位转换使用的ID | ||||
| SolarIrradiance | 太阳辐照度，在地球表面测量的太阳电磁辐射（全球水平辐照度）。 可以为空。 | ||||
| Value | 太阳辐照度取整数 | ||||
| Unit | 太阳辐照度数值的单位类型 单位：瓦特/平方米（W/㎡） | ||||
| UnitType | 用于单位转换使用的ID | ||||
| Sources | 预报来源 | ||||
| MobileLink | 跳转至的华风爱科/Accuweather移动端网页的链接 | ||||
| Link | 跳转至的华风爱科/Accuweather网页的链接 |