指数API开发指南
基本信息
指数分为中国指数和国外指数:本节为国内指数文档。
- 华风爱科 API提供给用户一个简洁RESTful Web接口,用以访问基于位置的天气数据。
- 数据搜索需要Location key。请使用定位API ,以获得您需要位置的Location key。
- 用户可使用华风爱科提供的Location Key调取任何种类的日常指数列表。
- 天气指数可支持1天。如需更多指数服务和预报天数请联系商务。
- 用户可使用index id指定调取某日常指数。
- 点此查看指数列表详情页,此页包含API内支持的指数元数据分组以及指定指数分级等信息。
- 指数支持中英文语言。如需要更多语言与本地化方言请联系商务。
API服务地址
请求URL
类型 | URL | 请求方式 |
---|---|---|
使用LocationKey调取1日指数 | https://openapi.weathercn.com/indices/{version}/daily/1day/{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或false value (details = true) | false | 可选 |
index id | 用于识别特定指数的数字ID | No filter | 可选 |
返回参数
参数 | 说明 |
---|---|
Name | 指数名称 |
ID | 用于识别特定指数的数字ID |
Ascending | 指数上升值描述,当该值为true时,最差值为0,最佳值为10,当该值为false时,最差值为10,最佳值为0 |
LocalDateTime | 指数有效期日期与时间, ISO8601 格式: yyyy-mm-ddThh:mm:ss±hh:mm |
EpochDateTime | 指数有效期的UNIX时间,从协调世界时1970年1月1日0时0分0秒起至现在的总秒数,不考虑闰秒 (午夜 UTC/GMT) |
Value | 范围为0.0到10.0的指数值 |
Category | 根据指数值判断出来的指数级别分类。不同指数的会有指数级别分类 |
CategoryValue | 根据指数值判断出来的指数级别分类整数1到5的数值,该数值为1到5。因各指数有区别,该数值需与上升标注合并使用 |
Text | 用于展示的指数值与级别分类的概括句子 |
MobileLink | 跳转至的华风爱科/Accuweather移动端网页的链接 |
Link | 跳转至的华风爱科/Accuweather网页的链接 |
调用示例
使用LocationKey调取1日指数
jsonhttps://openapi.weathercn.com/indices/v1/daily/1day/101924/100?apikey=<用户的key>&language=zh-cn&details=true