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

From CaiyunWiki
Jump to: navigation, search
(Created page with "{{彩云天气 API 版本状态}} =='''授权与认证'''== 请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token...")
 
m (remove province station)
 
(12 intermediate revisions by 3 users not shown)
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@caiyunapp.com'''
  
<code>
+
把您的 token 拼到 API 请求的 URL 中,如: [http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN <code>http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN</code>]
<nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/realtime.json</nowiki>
 
</code>
 
  
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人!
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人!
  
=='''请求样例'''==
+
=='''请求样例及参数说明'''==
 
+
请求国控站点的数据:
===== 示例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>
 
  
 +
[http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN <code>http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN</code>]
 
=='''返回结构和说明'''==
 
=='''返回结构和说明'''==
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
  
{   status:ok,
+
{
    api_version:v2.2,                                          // 版本号
+
status:     ok
    api_status:active,                                        // 版本号状态
+
category:   aqi_latest_obs_city
    lang:zh_CN,                                                // 语言
+
result: {
    unit:metric,                                              // 单位制
+
            0000A02880:                                                   ## 彩云全球雾霾站点编号(10位字符串)
    result:{
+
                      { station_code: "0000A02880",                       ## 彩云全球雾霾站点编号(10位字符串)
        status:ok,                                            // 实况模块返回状态
+
                          area:         "成都市",                           ## 站点所在城市、城区、县级名称(中文或者英文)
        temperature:28.0,                                          // 温度
+
                          province_name:"四川",                             ## 站点所在省的名称
        pres: 100991.3,                                            // 气压
+
                          position_name:"大石西路",                        ## 站点地址(中文或者英文)
        humidity:0.92,                                            // 相对湿度
+
                          lon:         "104.0238889",
        wind:{direction:25.33,                                     // 风向,单位是度。正北方向为0度,顺时针增加到360度。
+
                          lat:         "30.65638889",                     ## 经纬度
              speed:83.3},                                        // 风速,米制下是公里每小时
+
                          time_point: "2019-01-14T17:00:00Z+08:00",       ## 观测时间和时区信息
         precipitation:{ nearest:{status:ok,
+
                          quality:     "轻度污染",                         ## 空气污染等级,自然语言描述(中文)
                                distance:0.77,                   // 最近的降水带距离
+
                          primary_pollutant: "细颗粒物(PM2.5)",             ## 主要污染物(中文)
                                intensity:0.3125},               // 最近的降水带降水强度(单位为雷达降水强度)
+
                          pm25:         "91",                               ## 细颗粒污染[μg/m3],缺测为“null”
                         local:{status:ok,
+
                          pm10:         "134",                             ## 粗颗粒污染[μg/m3],缺测为“null”
                              intensity:0.2812,                  // 本地降水强度(单位为雷达降水强度)
+
                          o3:         "null",                             ## 臭氧[μg/m3],缺测为“null”
                              datasource:radar} },                // 本地降水观测的数据源(radar,GFS)
+
                          no2:         "49"                                ## 二氧化氮[μg/m3],缺测为“null”
         cloudrate:0.51,                                           // 云量
+
                          so2:         "8",                               ## 二氧化硫[μg/m3],缺测为“null”
        dswrf: 8.3,                                                // 向下短波辐射通量
+
                          co:         "1.1",                             ## 一氧化碳[mg/m3],缺测为“null”
         visibility: 8.3,                                           // 能见度
+
                          aqi:         "120"                              ## AQI(中国自然资源部,国标)
 
+
                      },
        skycon:RAIN,                                              // 主要天气现象
+
            0000A02317:{...},
        comfort: {                                                // 舒适度指数及其自然语言描述
+
            ...
            index: 7,
+
        }
            desc: 冷},
 
        ultraviolet: {                                            // 紫外线指数及其自然语言描述
 
          index: 0,
 
          desc: 无},
 
 
 
        pm25: 18,                                                 // pm25,质量浓度值
 
        pm10: 46,                                                 // pm10,质量浓度值
 
        o3: 47,                                                   // 臭氧,质量浓度值
 
        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 产品]]

Latest revision as of 03:08, 28 May 2020

授权与认证

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

使用本接口,开发者token需要额外开通权限,请联系商务:api@caiyunapp.com

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

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

请求样例及参数说明

请求国控站点的数据:

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

返回结构和说明

{
status:	     ok
category:    aqi_latest_obs_city
result:	{
             0000A02880:                                                    ## 彩云全球雾霾站点编号10位字符串
                       {  station_code:	"0000A02880",                       ## 彩云全球雾霾站点编号10位字符串
                          area:	        "成都市",                           ## 站点所在城市城区县级名称中文或者英文
                          province_name:"四川",                             ## 站点所在省的名称
                          position_name:"大石西路",                         ## 站点地址中文或者英文
                          lon:	        "104.0238889",
                          lat:	        "30.65638889",                      ## 经纬度
                          time_point:	"2019-01-14T17:00:00Z+08:00",       ## 观测时间和时区信息
                          quality:      "轻度污染",                         ## 空气污染等级自然语言描述中文
                          primary_pollutant: "细颗粒物(PM2.5)",             ## 主要污染物中文
                          pm25:	        "91",                               ## 细颗粒污染[μg/m3]缺测为null
                          pm10:	        "134",                              ## 粗颗粒污染[μg/m3]缺测为null
                          o3:	        "null",                             ## 臭氧[μg/m3]缺测为null
                          no2:	        "49"                                ## 二氧化氮[μg/m3]缺测为null
                          so2:	        "8",                                ## 二氧化硫[μg/m3]缺测为null
                          co:	        "1.1",                              ## 一氧化碳[mg/m3]缺测为null
                          aqi:	        "120"                               ## AQI中国自然资源部国标
                       },
             0000A02317:{...},
             ...
         }
}