预警API开发指南

基本信息

• 华风爱科 API提供给用户一个简洁的RESTful Web接口，用以访问基于位置的天气数据。
• 预警支持中英文语言。如需要更多语言与本地化方言请联系商务。
• 预警搜索需Location key配合。请使用定位API调取您所需要搜索的地点Location key。
• 默认情况下，返回的预警文字为简短版。完整的的预警文字可以通过给URL字符串传递“details=true”得到。
• 如果同一地点有多个预警，API返回的预警将依据优先级依次排行，最高优先级的预警将排在响应最高位置。

API服务地址

请求URL

类型	URL	请求方式
使用LocationKey调取预警数据	https://openapi.weathercn.com/alerts/{version}/{locationKey}{.{format}}?apikey=<用户的key>{&language={language code}}{&details={true or false}}	GET

请求参数

参数	说明	默认值
apikey	用以在API里验证与授权使用的用户密钥	N/A	必选
version	当前API版本	v1	必选
locationkey	用以搜索指定地点的特定ID	N/A	必选
format	响应格式	JSON	可选
language	指定响应数据语言的字符串	zh-cn	可选
details	用以判断是否返回预警完整文字的布尔值(true or false)	False	可选

返回参数

参数			说明
CountryCode			特定国家代码ID
AlertID			用于辨识预警在某一国家的特定数字ID
Description			说明
	Localized		本地化语言的预警说明
	English		英文预警说明
Category			预警类型
Priority			优先级数值，用于对预警严重性在预警原发地优先级排名。数字越低优先级越高，1代表最高优先级
Type			缩写形式的预警说明
TypeId			预警说明相关联的ID
Class			预警分类（部分国家支持）
Level			预警严重性识别（部分国家支持）
Color			颜色
	Name		名称
	Red		红
	Green		绿
	Blue		蓝
	Hex		十六进制色
Source			预警数据提供方
SourceId			预警数据提供方ID
Disclaimer			与预警数据必须一起显示的免责声明
Area			区域
	Name		预警请求地点覆盖范围内的区域名称
	StartTime		预警开始日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm
	EpochStartTime		预警开始的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT)
	EndTime		预警结束日期与时间， ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm
	EpochEndTime		预警结束的UNIX时间，从协调世界时1970年1月1日0时0分0秒起至现在的总秒数，不考虑闰秒 (午夜 UTC/GMT)
	LastAction		最新状态，如下： New、Extend、Cancel、Change、Correct、Expire、Upgrade、Continue、Downgrade、Update；
		Localized	本地化语言的预警状态
		English	英文预警状态
	Text		预警相关联的完整文字
	LanguageCode		预警相关联的完整文字语言
	Summary		英文预警概要
MobileLink			跳转至的华风爱科/Accuweather移动端网页的链接
Link			跳转至的华风爱科/Accuweather网页的链接

调用示例

1. 使用LocationKey调取预警数据

   https://openapi.weathercn.com/alerts/v1/101924.json?apikey=<用户的key>&language=zh-cn&details=true

   在线体验