View source for 通用预报接口/v2.5

{{导览}}

{{彩云天气 API 版本状态}}

== 授权与认证 ==
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册]，注册后可以获得 token 。

把您的 token 拼到 API 请求的 URL 中，如

<code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</code>

其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人！

== API 请求 ==

=== 示例 ===

这里是测试 token ，即 <code>TAkhjf8d1nlSlspN</code>

* <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</code>
* <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.jsonp?callback=MYCALLBACK</code>

=== 请求参数 ===

* 经纬度：必须，无缺省值，经度在前，纬度在后，中间用半角逗号隔开，如 <code>118.266637,26.150279</code>
* 返回格式：必须，无缺省值，可选项目包括json 或者 jsonp，jsonp 需提供回调函数名
* 语言选项 lang: 可选，缺省值是 <code>zh_CN</code>，可选项目包括简体中文（zh_CN，默认）、繁体中文（zh_TW）、美式英语（en_US）、英式英语（en_GB）、日语（ja）
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/-74.0060,40.7128/weather.json?lang=en_US</code>
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/139.7690,35.6804/weather.json?lang=ja</code>
* 单位制选项 unit: 可选，缺省值是 <code>metric</code>，可选项目包括公制<code>metric</code>，英制<code>imperial</code>，和科学单位制 <code>SI</code>
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial</code>
* 小时步长选项 hourlysteps: 可选，缺省值是 <code>48</code>，选择范围 <code> 1 ~ 360 </code>
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?hourlysteps=12</code>
* 天步长选项 dailysteps: 可选，缺省值是 <code>5</code>，选择范围 <code> 1 ~ 15 </code>
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?dailysteps=3</code>
* 预警信息 alert：可选，缺省值是 <code>false</code>，选择范围 <code> true </code> 或者 <code> false </code>
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?alert=true</code>

== API 返回值 ==

=== 返回结构说明 ===

通用预报接口可以认为是如下几个不同时间颗粒度接口的合并

* [[实况天气接口/v2.5|实况天气接口]]
* [[分钟级降雨预报接口/v2.5|分钟级降雨预报接口]]
* [[小时级预报接口/v2.5|小时级预报接口]]
* [[天级预报接口/v2.5|天级预报接口]]

所以，返回结构的细节可以在上述几个接口的文档中查看。

<syntaxhighlight lang="yaml">

status: ok
api_version: v2.5
api_status: active
lang: zh_CN
unit: metric
tzshift: 28800
timezone: Asia/Shanghai
server_time: 1585894300
location:
location:
  - 26.150279
  - 118.266637
result:
  alert:
    status: ok
    content:
      request_status: "ok",
      alertId: "35040041600001_20200421123203",
      latlon: [26.263406,117.638678]
      pubtimestamp: 1587443583
      status: "预警中"
      regionId: "unknown"
      adcode: "350400"
      location: "福建省三明市"
      province: "福建省"
      city: "三明市"
      county: "无"
      code: "0902"
      source: "国家预警信息发布中心",
      title: "三明市气象台发布雷电黄色预警[Ⅲ级/较重]",
      description: "三明市气象台2020年04月21日12时19分继续发布雷电黄色预警信号：预计未来6小时我市有雷电活动，局地伴有短时强降水、6-8级雷雨大风等强对流天气。请注意防范！"
  realtime:
    status: ok
    temperature: 46.92
    humidity: 0.6
    cloudrate: 0.99
    skycon: LIGHT_RAIN
    visibility: 14.99
    dswrf: 0
    wind:
      speed: 20.04
      direction: 327.03
    pressure: 100027.48
    apparent_temperature: 52.9
    precipitation:
      local:
        status: ok
        datasource: radar
        intensity: 0.245
      nearest:
        status: ok
        distance: 0
        intensity: 6
    air_quality:
      pm25: 0
      pm10: 0
      o3: 0
      so2: 0
      no2: 0
      co: 0
      aqi:
        chn: 0
        usa: 0
      description:
        usa: ''
        chn: missing
    life_index:
      ultraviolet:
        index: 0
        desc: None
      comfort:
        index: 2
        desc: Very hot
  minutely:
    status: ok
    datasource: radar
    precipitation_2h:
    - 0.245
    precipitation:
    - 0.245
    probability:
    - 0.9703164364
    description: "您西北9公里正在下小雨哦"
  hourly:
    status: ok
    description: 阴，今天傍晚20点钟后转小雨，其后阴
    precipitation:
    - datetime: 2020-04-03T02:00-04:00
      value: 0.021
    temperature:
    - datetime: 2020-04-03T02:00-04:00
      value: 46.92
    wind:
    - datetime: 2020-04-03T02:00-04:00
      speed: 20.04
      direction: 327.03
    humidity:
    - datetime: 2020-04-03T02:00-04:00
      value: 0.6
    skycon:
    - datetime: 2020-04-03T02:00-04:00
      value: LIGHT_RAIN
    pressure:
    - datetime: 2020-04-03T02:00-04:00
      value: 100027.4809084723
    visibility:
    - datetime: 2020-04-03T02:00-04:00
      value: 14.99
    dswrf:
    - datetime: 2020-04-03T02:00-04:00
      value: 0
    air_quality:
      aqi:
      - datetime: 2020-04-03T02:00-04:00
        value:
          chn: 0
          usa: 0
      pm25:
      - datetime: 2020-04-03T02:00-04:00
        value: 0
  daily:
    status: ok
    astro:
    - date: 2020-04-03T00:00-04:00
      sunrise:
        time: '06:34'
      sunset:
        time: '19:23'
    precipitation:
    - date: 2020-04-03T00:00-04:00
      max: 0.028
      min: 0
      avg: 0.0075
    temperature:
    - date: 2020-04-03T00:00-04:00
      max: 51.35
      min: 46.92
      avg: 49.74
    wind:
    - date: 2020-04-03T00:00-04:00
      max:
        speed: 20.04
        direction: 327.03
      min:
        speed: 13.17
        direction: 12.79
      avg:
        speed: 16.85
        direction: 347.62
    humidity:
    - date: 2020-04-03T00:00-04:00
      max: 0.76
      min: 0.57
      avg: 0.71
    cloudrate:
    - date: 2020-04-03T00:00-04:00
      max: 1
      min: 0.95
      avg: 1
    pressure:
    - date: 2020-04-03T00:00-04:00
      max: 100814.14
      min: 99934.41
      avg: 100305.84
    visibility:
    - date: 2020-04-03T00:00-04:00
      max: 14.99
      min: 9.67
      avg: 12.62
    dswrf:
    - date: 2020-04-03T00:00-04:00
      max: 138.9
      min: 0
      avg: 41.4
    air_quality:
      aqi:
      - date: 2020-04-03T00:00-04:00
        max:
          chn: 0
          usa: 0
        avg:
          chn: 0
          usa: 0
        min:
          chn: 0
          usa: 0
      pm25:
      - date: 2020-04-03T00:00-04:00
        max: 0
        avg: 0
        min: 0
    skycon:
    - date: 2020-04-03T00:00-04:00
      value: LIGHT_RAIN
    life_index:
      ultraviolet:
      - date: 2020-04-03T00:00-04:00
        index: '1'
        desc: 最弱
      carWashing:
      - date: 2020-04-03T00:00-04:00
        index: '3'
        desc: 较不适宜
      dressing:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 温暖
      comfort:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 温暖
      coldRisk:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 极易发
  forecast_keypoint: "您西北9公里正在下小雨哦"

</syntaxhighlight>

=== 返回错误 ===

=== 天气变量 ===

====实况级部分的天气变量====

{{:实况天气接口/v2.5/天气变量}}

====分钟级部分的天气变量====

{{:分钟级降雨预报接口/v2.5/天气变量}}

====小时级部分的天气变量====

{{:小时级预报接口/v2.5/天气变量}}

====天级部分的天气变量====

{{:天级预报接口/v2.5/天气变量}}

=== 预警信息 ===

{{:天气预警信息}}

=== 自然语言描述 ===

== 变量详细说明 ==

===支持的单位制===

{{Template:彩云天气 API/支持的单位制}}

===雷达降水强度===

{{:雷达降水强度}}

== 常量详细说明 ==

===天气现象代码===

{{:天气现象代码表}}

===生活指数等级===

{{:生活指数等级}}

[[Category:API 产品]]

[[en:General weather interface/v2.5]]