Difference between revisions of "实况天气接口/v2.2"

From Caiyun Wiki
Jump to: navigation, search
(要素)
Line 3: Line 3:
 
==授权与认证==
 
==授权与认证==
  
{{彩云天气 API/授权与认证}}
+
===授权===
 +
 
 +
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。
 +
 
 +
===认证===
 +
 
 +
把您的 token 拼到 API 请求的 URL 中,如
 +
 
 +
<code>
 +
https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json
 +
</code>
 +
 
 +
其中 TAkhjf8d1nlSlspN 就是一个测试 token 。请注意不要把你的 token 告诉任何其他人。
  
 
==天气现象==
 
==天气现象==

Revision as of 14:20, 25 October 2018

本文版本:实况天气接口/v2.2,当前稳定版本版本:v2.5,历史版本:v2.2v2.3,和 v2.4

授权与认证

授权

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

认证

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

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

其中 TAkhjf8d1nlSlspN 就是一个测试 token 。请注意不要把你的 token 告诉任何其他人。

天气现象

天气现象 代码
晴(白天) 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.realtime.skycon 天气状况 实时 全球 实时的天气状况
实时温度 $.result.realtime.temperature 温度 实时 全球 实时的温度
最近降水带距离 $.result.realtime.precipitation.nearest.distance 距离 实时 全球 最近降水带到达本地的距离
最近降水强度 $.result.realtime.precipitation.nearest.intensity 降水强度 实时 全球 最近降水处的降水强度
本地降水强度 $.result.realtime.precipitation.local.intensity 降水强度 实时 全球 最近降水处的降水强度
实时风向 $.result.realtime.wind.direction 风向 实时 全球 实时的风向
实时风速 $.result.realtime.wind.speed 风速 实时 全球 实时的风速
实时相对湿度 $.result.realtime.humidity 相对湿度 实时 全球 实时的相对湿度
实时气压 $.result.realtime.pres 气压 实时 全球 实时的气压
实时云量 $.result.realtime.cloudrate 云量 实时 全球 实时的云量
实时能见度 $.result.realtime.visibility 能见度 实时 全球 实时的能见度
实时臭氧浓度 $.result.realtime.o3 臭氧浓度 实时 中国 实时的臭氧浓度
实时一氧化碳浓度 $.result.realtime.co 一氧化碳浓度 实时 中国 实时的一氧化碳浓度
实时二氧化氮浓度 $.result.realtime.no2 二氧化氮浓度 实时 中国 实时的二氧化氮浓度
实时二氧化硫浓度 $.result.realtime.so2 二氧化硫浓度 实时 中国 实时的二氧化硫浓度
实时PM25浓度 $.result.realtime.pm25 PM25浓度 实时 中国 实时的PM25浓度
实时PM10浓度 $.result.realtime.pm10 PM10浓度 实时 中国 实时的PM10浓度
实时AQI $.result.realtime.aqi AQI 实时 中国 实时的AQI
实时舒适度指数 $.result.realtime.comfort.index 舒适度指数 实时 全球 实时的舒适度指数
实时紫外线指数 $.result.realtime.ultraviolet.index 紫外线指数 实时 全球 实时的紫外线指数

请求格式

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

https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.jsonp?callback=MYCALLBACK

注意如下格式信息:

  • token :这里是测试 token ,即 TAkhjf8d1nlSlspN
  • 经纬度:经度在前,纬度在后,中间用半角逗号隔开,这里是 121.6544,25.1552
  • 返回格式:json 或者 jsonp,jsonp 需提供回调函数名

请求参数

示例如下:

https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json?lang=en_US&unit=metric&tzshift=14400

  • 语言选项 lang
  • 单位制选项 unit
  • 时区偏移秒数 tzshift

数据返回样例和说明

{
    "status":"ok",
    "lang":"zh_CN",  // 语言
    "server_time":1443418222,
    "tzshift":28800, // 时区的偏移秒数,如东八区就是 28800 秒,使用秒是为了支持像尼泊尔这样的差 5 小时 45 分钟的地区,它们有非整齐的偏移量
    "location":[
        25.1552, // 纬度
        121.6544 // 经度
    ],
    "unit":"metric", // 单位制
    "result":{
        "status":"ok",
        "temperature":28.0,  // 温度
        "skycon":"RAIN",  // 天气概况
        "o3": 47,         // 臭氧值
        "co": 0.3,        // 一氧化碳值
        "no2": 14,        // 二氧化氮值
        "so2": 1,         // 二氧化硫值
        "pm25": 18,       // pm25值
        "pm10": 46,       // pm10值
        "aqi": 46,        // aqi值
        "pres": 100991.3,  // 气压
        "cloudrate":0.51,  // 云量
        "humidity":0.92,   // 相对湿度
        "visibility": 8.3, // 能见度
        "precipitation":{  // 降水
             "nearest":{ // 最近的降水带
                 "status":"ok",
                 "distance":0.77, //距离
                 "intensity":0.3125 //降水强度
             },
            "local":{ //本地的降水
                "status":"ok",
                "intensity":0.2812, //降水强度
                "datasource":"radar" //数据源
            }
        },
        "wind":{ //风
            "direction":25.33, //风向。单位是度。正北方向为0度,顺时针增加到360度。
            "speed":83.3 //风速,米制下是公里每小时
        },
        "comfort": {  //舒适度指数
            "index": 7,
            "desc": "冷"
        },
        "ultraviolet": {  //紫外线指数
           "index": 0,
           "desc": "无"
        }
    }
}