Difference between revisions of "小时级预报接口/v2.2"

From Caiyun Wiki
Jump to: navigation, search
(示例2如下)
(返回结构和说明)
Line 23: Line 23:
 
==返回结构和说明==
 
==返回结构和说明==
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
{
+
 
    status:ok,
+
{status:ok,
    lang:zh_CN, // 语言
+
  api_version:v2.2,
    server_time:1443418222,
+
api_status:active,
    tzshift:28800, // 时区的偏移秒数,如东八区就是 28800 秒,使用秒是为了支持像尼泊尔这样的差 5 小时 45 分钟的地区,它们有非整齐的偏移量
+
lang:en_US,
    location:[
+
unit:metric,
        25.1552, // 纬度
+
result:{
        121.6544 // 经度
+
         hourly:{
    ],
+
            status:ok,
    unit:metric, // 单位制
+
            temperature:[{value:23.0,datetime:2018-11-20 10:00},{value:22.0,datetime:2018-11-20 11:00}]},
    result:{
+
            pres:[{value:100279.8643200001,datetime:2018-11-20 10:00},{value:100249.1918336001,datetime:2018-11-20 11:00}],
         status:ok,
+
            humidity:[{value:0.77,datetime:2018-11-20 10:00},{value:0.77,datetime:2018-11-20 11:00}],
        temperature:28.0, // 温度
+
            wind:[
        skycon:RAIN, // 天气概况
+
                {  direction:95.62,
        o3: 47,         // 臭氧值
+
                    speed:22.85,datetime:2018-11-20 10:00},
        co: 0.3,       // 一氧化碳值
+
                {  direction:97.97,
        no2: 14,       // 二氧化氮值
+
                    speed:23.27,datetime:2018-11-20 11:00}],
        so2: 1,         // 二氧化硫值
+
            precipitation:[
        pm25: 18,       // pm25值
+
                {value:0.0,datetime:2018-11-20 10:00},
        pm10: 46,      // pm10值
+
                {value:0.0,datetime:2018-11-20 11:00}],
        aqi: 46,       // aqi值
+
            cloudrate:[{value:0.77,datetime:2018-11-20 10:00},{value:0.46,datetime:2018-11-20 11:00}],
        pres: 100991.3, // 气压
+
             dswrf:[{value:344.09456384,datetime:2018-11-20 10:00},{value:325.9617024,datetime:2018-11-20 11:00}],
        cloudrate:0.51, // 云量
+
             skycon:[{value:PARTLY_CLOUDY_DAY,datetime:2018-11-20 10:00},{value:PARTLY_CLOUDY_DAY,datetime:2018-11-20 11:00}],
        humidity:0.92,   // 相对湿度
+
            description:cloudy, clear weather after 7 tomorrow morning, increasing cloudiness,
        visibility: 8.3, // 能见度
+
 
        precipitation:{ // 降水
+
            pm25:[{value:8,datetime:2018-11-20 10:00},{value:9,datetime:2018-11-20 11:00}],
            nearest:{ // 最近的降水带
+
             aqi:[{value:33,datetime:2018-11-20 10:00},{value:13,datetime:2018-11-20 11:00}],
                status:ok,
+
             visibility:[{value:23.24,datetime:2018-11-20 10:00},{value:23.0,datetime:2018-11-20 11:00}],
                distance:0.77, //距离
+
             forecast_keypoint:cloudy, clear weather after 7 tomorrow morning, increasing cloudiness,primary:0},
                intensity:0.3125 //降水强度
+
location:[25.1552,
            },
+
           121.6544]
             local:{ //本地的降水
+
placename:Unnamed Road, Wanli District, New Taipei City, Taiwan 207,
                status:ok,
+
server_time:1542695724,
                intensity:0.2812, //降水强度
+
tzshift:14400,
                datasource:radar //数据源
 
             }
 
        },
 
        wind:{ //风
 
             direction:25.33, //风向。单位是度。正北方向为0度,顺时针增加到360度。
 
             speed:83.3 //风速,米制下是公里每小时
 
        },
 
        comfort: {  //舒适度指数
 
             index: 7,
 
            desc:
 
        },
 
        ultraviolet: {  //紫外线指数
 
           index: 0,
 
          desc:
 
        }
 
    }
 
 
}
 
}
  

Revision as of 06:41, 20 November 2018

本文版本:小时级预报接口/v2.2,当前稳定版本版本:v2.5,历史版本:v2.2v2.3,和 v2.4

授权与认证

请先至彩云开放平台注册,注册后可以获得 token 。

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

https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/hourly.json

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

请求样例

示例1如下

https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/hourly.jsonhttps://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/hourly.jsonp?callback=MYCALLBACK
token:这里是测试 token ,即 TAkhjf8d1nlSlspN
经纬度:经度在前,纬度在后,中间用半角逗号隔开,这里是 121.6544,25.1552
返回格式:json 或者 jsonp,jsonp 需提供回调函数名

示例2如下

https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/hourly.json?lang=en_US&unit=metric&tzshift=14400&?hourlysteps=2
语言选项 lang:(简体中文(zh_CN)、繁体中文(zh_TW)、美式英语(en_US)、英式英语(en_GB))
经纬度附近地址中英文名称:getplacename=True
单位制选项 unit:(科学单位体系(SI) 、公制(metric)、英制(imperial))、(降水单位:mm/h)
时区偏移秒数:tzshift:(例如:印度东5.5区,tzshift=3600*5.5==19800,v2.3之后版本,返回时区信息)
定制返回变量列表:fields=tmp,vis 【'ast', 'rad', 'prc', 'tmp', 'wnd', 'hmd', 'cld', 'aqi', 'pm25', 'pm25w', 'sky', 'skyh', 'lfi', 'alr', 'pres', 'vis', 'dswrf'】
定制返回预报总小时数:hourlysteps:(例如:未来360小时,未来2小时)

返回结构和说明

{status:ok,
 api_version:v2.2,
 api_status:active,
 lang:en_US,
 unit:metric,
 result:{
        hourly:{
            status:ok,
            temperature:[{value:23.0,datetime:2018-11-20 10:00},{value:22.0,datetime:2018-11-20 11:00}]},
            pres:[{value:100279.8643200001,datetime:2018-11-20 10:00},{value:100249.1918336001,datetime:2018-11-20 11:00}],
            humidity:[{value:0.77,datetime:2018-11-20 10:00},{value:0.77,datetime:2018-11-20 11:00}],
            wind:[
                {   direction:95.62,
                    speed:22.85,datetime:2018-11-20 10:00},
                {   direction:97.97,
                    speed:23.27,datetime:2018-11-20 11:00}],
            precipitation:[
                {value:0.0,datetime:2018-11-20 10:00},
                {value:0.0,datetime:2018-11-20 11:00}],
            cloudrate:[{value:0.77,datetime:2018-11-20 10:00},{value:0.46,datetime:2018-11-20 11:00}],
            dswrf:[{value:344.09456384,datetime:2018-11-20 10:00},{value:325.9617024,datetime:2018-11-20 11:00}],
            skycon:[{value:PARTLY_CLOUDY_DAY,datetime:2018-11-20 10:00},{value:PARTLY_CLOUDY_DAY,datetime:2018-11-20 11:00}],
            description:cloudy, clear weather after 7 tomorrow morning, increasing cloudiness,

            pm25:[{value:8,datetime:2018-11-20 10:00},{value:9,datetime:2018-11-20 11:00}],
            aqi:[{value:33,datetime:2018-11-20 10:00},{value:13,datetime:2018-11-20 11:00}],
            visibility:[{value:23.24,datetime:2018-11-20 10:00},{value:23.0,datetime:2018-11-20 11:00}],
            forecast_keypoint:cloudy, clear weather after 7 tomorrow morning, increasing cloudiness,primary:0},
 location:[25.1552,
           121.6544]
 placename:Unnamed Road, Wanli District, New Taipei City, Taiwan 207,
 server_time:1542695724,
 tzshift:14400,
}

天气现象

天气现象 代码
晴(白天) CLEAR_DAY
晴(夜间) CLEAR_NIGHT
多云(白天) PARTLY_CLOUDY_DAY
多云(夜间) PARTLY_CLOUDY_NIGHT
CLOUDY
大风 WIND
雾霾 HAZE
RAIN
SNOW

支持的语言

目前支持的语言包括:简体中文(zh_CN)、繁体中文(zh_TW)、美式英语(en_US)、英式英语(en_GB)

支持的单位制

1.目前支持的单位制包括:科学单位体系(SI,大写)、英制(imperial)、公制(不带参数&unit默认公制,公制还包括: metric:v1和metric:v2):

单位制
要素
SI(科学单位体系) imperial(英制) metric:v1(公制v1) metric:v2(公制v2) default metric(默认公制)
实况降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度(0~1) 毫米/小时(mm/hr) 雷达降水强度(0~1)
逐分钟降水短临预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度(0~1) 毫米/小时(mm/hr) 雷达降水强度(0~1)
逐小时预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度(0~1) 毫米/小时(mm/hr) 毫米/小时(mm/hr)
逐日预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度(0~1) 毫米/小时(mm/hr) 毫米/小时(mm/hr)
距离 米(m) 英里(mi) 公里(km) 公里(km) 公里(km)
温度 开尔文(K) 华氏度(℉) 摄氏度(℃) 摄氏度(℃) 摄氏度(℃)
气压 帕(Pa) 帕(Pa) 帕(Pa) 帕(Pa) 帕(Pa)
相对湿度 0~1 0~1 0~1 0~1 0~1
风向 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°)
风速 米/秒(m/s) 英里/小时(mi/hr) 公里/小时(km/hr) 公里/小时(km/hr) 公里/小时(km/hr)
云量 0~1 0~1 0~1 0~1 0~1
能见度 米(m) 英里(mi) 公里(km) 公里(km) 公里(km)

unit=metric:v1时,所有类型中precipitation的单位都是:雷达降水强度(0~1)

unit=metric:v2时,所有类型中precipitation的单位都是:毫米/小时(mm/hr)

2.判断降水等级:

  • 带参数&unit=metric:v1,请求实况、分钟级、逐小时和逐日降水强度,单位都为雷达降水强度(0 ~ 1);
  • 雷达降水强度(0 ~ 1)判断降水等级:0.03~0.25 小雨(雪), 0.25~0.35 中雨(雪), 0.35~0.48大雨(雪), >0.48 暴雨(雪);
  • v2.4版本中,本地存在降水时,可以根据skycon(存在于realtime、hourly、daily字段),和skycon_08h_20h和skycon_20h_32h(存在于daily字段),中的:LIGHT_RAIN, MODERATE_RAIN, HEAVY_RAIN, STORM_RAIN(LIGHT_SNOW, MODERATE_SNOW, HEAVY_SNOW,STORM_SNOW)直接获取降水等级
  • 大暴雨(雪)和特大暴雨(雪),需要根据24小时累计公制降水量(mm/24hr)来判断,研发中...

要素

名称 健值路径(jsonpath) 时间粒度 地理范围 注释
天气状况 $.result.hourly[*].skycon 天气状况 小时 全球 的天气状况
温度 $.result.hourly[*].temperature 温度 小时 全球 的温度
最近降水带距离 $.result.hourly[*].precipitation.nearest.distance 距离 小时 全球 最近降水带到达本地的距离
最近降水强度 $.result.hourly[*].precipitation.nearest.intensity 降水强度 小时 全球 最近降水处的降水强度
本地降水强度 $.result.hourly[*].precipitation.local.intensity 降水强度 小时 全球 最近降水处的降水强度
风向 $.result.hourly[*].wind.direction 风向 小时 全球 的风向
风速 $.result.hourly[*].wind.speed 风速 小时 全球 的风速
相对湿度 $.result.hourly[*].humidity 相对湿度 小时 全球 的相对湿度
气压 $.result.hourly[*].pres 气压 小时 全球 的气压
云量 $.result.hourly[*].cloudrate 云量 小时 全球 的云量
能见度 $.result.hourly[*].visibility 能见度 小时 全球 的能见度
臭氧浓度 $.result.hourly[*].o3 臭氧浓度 小时 中国 的臭氧浓度
一氧化碳浓度 $.result.hourly[*].co 一氧化碳浓度 小时 中国 的一氧化碳浓度
二氧化氮浓度 $.result.hourly[*].no2 二氧化氮浓度 小时 中国 的二氧化氮浓度
二氧化硫浓度 $.result.hourly[*].so2 二氧化硫浓度 小时 中国 的二氧化硫浓度
PM25浓度 $.result.hourly[*].pm25 PM25浓度 小时 中国 的PM25浓度
AQI $.result.hourly[*].aqi AQI 小时 中国 的AQI
舒适度指数 $.result.hourly[*].comfort.index 舒适度指数 小时 全球 的舒适度指数
紫外线指数 $.result.hourly[*].ultraviolet.index 紫外线指数 小时 全球 的紫外线指数