Difference between revisions of "空气污染实况接口"

From Caiyun Wiki
Jump to: navigation, search
(Created page with "{{彩云天气 API 版本状态}} =='''授权与认证'''== 请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token...")
 
Line 1: Line 1:
{{彩云天气 API 版本状态}}
 
  
 
=='''授权与认证'''==
 
=='''授权与认证'''==
Line 5: Line 4:
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。
  
把您的 token 拼到 API 请求的 URL 中,如  
+
把您的 token 拼到 API 请求的 URL 中,如: [http://api.caiyunapp.com/v1/aqi?token=TAkhjf8d1nlSlspN http://api.caiyunapp.com/v1/aqi?<code>token=TAkhjf8d1nlSlspN</code>]
 
 
<code>
 
<nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json</nowiki>
 
</code>
 
  
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人!
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人!
  
 
=='''请求样例'''==
 
=='''请求样例'''==
 
+
<blockquote>[http://api.caiyunapp.com/v1/aqi?token=TAkhjf8d1nlSlspN http://api.caiyunapp.com/v1/aqi?<code>token=TAkhjf8d1nlSlspN</code>]</blockquote>
===== 示例1如下 =====
 
<blockquote><code> <nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json</nowiki> </code></blockquote><blockquote><code> <nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.jsonp?callback=MYCALLBACK</nowiki></code></blockquote><blockquote>'''token :'''这里是测试 token ,即 <code>TAkhjf8d1nlSlspN</code></blockquote><blockquote>'''经纬度:'''经度在前,纬度在后,中间用半角逗号隔开,这里是 <code>121.6544,25.1552</code></blockquote><blockquote>'''返回格式:'''json 或者 jsonp,jsonp 需提供回调函数名</blockquote>
 
 
 
==== 示例2如下 ====
 
<blockquote><code> <nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json?lang=en_US</nowiki> </code></blockquote><blockquote>'''语言选项 lang:'''默认为简体中文(zh_CN)、繁体中文(zh_TW)、美式英语(en_US)、英式英语(en_GB)</blockquote><blockquote>'''单位制选项 unit:'''默认为公制(metric)、科学单位体系(SI) 、英制(imperial)</blockquote><blockquote>'''时区偏移秒数 tzshift:'''默认为东八区,tzshift=28800;例如:印度东5.5区,tzshift=3600*5.5==19800,使用秒是为了支持像尼泊尔这样的差 5 小时 45 分钟的地区,它们有非整齐的偏移量</blockquote>
 
  
 
=='''返回结构和说明'''==
 
=='''返回结构和说明'''==
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
 
+
status "ok"
status:ok,
+
category "aqi_latest_obs_city"
    api_version:v2.2,                                          // 版本号
+
result
    api_status:active,                                        // 版本号状态
+
0000A02880
    lang:zh_CN,                                                // 语言
+
co 1.1
    unit:metric,                                              // 单位制
+
pm10 134
    result:{
+
quality "轻度污染"
        status:ok,                                            // 实况模块返回状态
+
area "成都市"
        temperature:28.0,                                          // 温度
+
o3 null
        pres: 100991.3,                                            // 气压
+
station_code "2880A"
        humidity:0.92,                                            // 相对湿度
+
lon 104.0238889
        wind:{direction:25.33,                                    // 风向,单位是度。正北方向为0度,顺时针增加到360度。
+
lat 30.65638889
              speed:83.3},                                        // 风速,米制下是公里每小时
+
so2 8
        precipitation:{ nearest:{status:ok,
+
no2 49
                                distance:0.77,                    // 最近的降水带距离
+
time_point "2019-01-14T17:00:00Z+08:00"
                                intensity:0.3125},                // 最近的降水带降水强度(单位为雷达降水强度)
+
position_name "大石西路"
                        local:{status:ok,
+
aqi 120
                              intensity:0.2812,                  // 本地降水强度(单位为雷达降水强度)
+
primary_pollutant "细颗粒物(PM2.5)"
                              datasource:radar} },                // 本地降水观测的数据源(radar,GFS)
+
pm25 91
        cloudrate:0.51,                                            // 云量
+
0000A02317
        dswrf: 8.3,                                                // 向下短波辐射通量
+
co 1.4
        visibility: 8.3,                                            // 能见度
+
pm10 null
 
+
quality "中度污染"
        skycon:RAIN,                                              // 主要天气现象
+
area "宣城市"
        comfort: {                                                // 舒适度指数及其自然语言描述
+
o3 26
            index: 7,
+
station_code "2317A"
            desc: 冷},
+
lon 118.7386
        ultraviolet: {                                            // 紫外线指数及其自然语言描述
+
lat 30.9742
          index: 0,
+
so2 14
          desc: 无},
+
no2 64
 
+
time_point "2019-01-14T17:00:00Z+08:00"
        pm25: 18,                                                  // pm25,质量浓度值
+
position_name "敬亭山子站"
        pm10: 46,                                                  // pm10,质量浓度值
+
aqi 180
        o3: 47,                                                    // 臭氧,质量浓度值
+
primary_pollutant "细颗粒物(PM2.5)"
        no2: 14,                                                  // 二氧化氮,质量浓度值
 
        so2: 1,                                                    // 二氧化硫,质量浓度值
 
        co: 0.3,                                                  // 一氧化碳,质量浓度值
 
        aqi: 46,                                                  // AQI(国标)
 
    },
 
    location:[25.1552,
 
              121.6544],                                      // 经纬度
 
    placename "崁脚里",                                    // 经纬度处地址
 
    server_time:1443418222,                                    // 服务器本次返回的utc时间戳
 
    tzshift:28800,                                            // 时区的偏移秒数,如东八区就是 28800 秒
 
}
 
 
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 
  
 
[[Category:API 产品]]
 
[[Category:API 产品]]

Revision as of 04:55, 15 January 2019

授权与认证

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

把您的 token 拼到 API 请求的 URL 中,如: http://api.caiyunapp.com/v1/aqi?token=TAkhjf8d1nlSlspN

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

请求样例

http://api.caiyunapp.com/v1/aqi?token=TAkhjf8d1nlSlspN

返回结构和说明

status	"ok"
category	"aqi_latest_obs_city"
result	
0000A02880	
co	1.1
pm10	134
quality	"轻度污染"
area	"成都市"
o3	null
station_code	"2880A"
lon	104.0238889
lat	30.65638889
so2	8
no2	49
time_point	"2019-01-14T17:00:00Z+08:00"
position_name	"大石西路"
aqi	120
primary_pollutant	"细颗粒物(PM2.5)"
pm25	91
0000A02317	
co	1.4
pm10	null
quality	"中度污染"
area	"宣城市"
o3	26
station_code	"2317A"
lon	118.7386
lat	30.9742
so2	14
no2	64
time_point	"2019-01-14T17:00:00Z+08:00"
position_name	"敬亭山子站"
aqi	180
primary_pollutant	"细颗粒物(PM2.5)"