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

From CaiyunWiki
Jump to: navigation, search
(请求样例)
m (remove province station)
 
(9 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。
  
把您的 token 拼到 API 请求的 URL 中,如: [http://api.caiyunapp.com/v1/aqi?token=TAkhjf8d1nlSlspN http://api.caiyunapp.com/v1/aqi?<code>token=TAkhjf8d1nlSlspN</code>]  
+
使用本接口,开发者token需要额外开通权限,请联系商务:'''api@caiyunapp.com'''
 +
 
 +
把您的 token 拼到 API 请求的 URL 中,如: [http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN <code>http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN</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>
+
请求国控站点的数据:
  
 +
[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
 
status:     ok
 
category:    aqi_latest_obs_city
 
category:    aqi_latest_obs_city
 
result: {
 
result: {
 
             0000A02880:                                                    ## 彩云全球雾霾站点编号(10位字符串)
 
             0000A02880:                                                    ## 彩云全球雾霾站点编号(10位字符串)
                       {  area:         "成都市",                          ## 站点所在城市、城区、县级名称(中文或者英文)
+
                       {  station_code: "0000A02880",                      ## 彩云全球雾霾站点编号(10位字符串)
                           station_code: "2880A",                           ## 所在国家雾霾站点编号(5位字符串)
+
                          area:         "成都市",                          ## 站点所在城市、城区、县级名称(中文或者英文)
 +
                           province_name:"四川",                             ## 站点所在省的名称
 
                           position_name:"大石西路",                        ## 站点地址(中文或者英文)
 
                           position_name:"大石西路",                        ## 站点地址(中文或者英文)
 
                           lon:         "104.0238889",
 
                           lon:         "104.0238889",
 
                           lat:         "30.65638889",                      ## 经纬度
 
                           lat:         "30.65638889",                      ## 经纬度
 
                           time_point: "2019-01-14T17:00:00Z+08:00",      ## 观测时间和时区信息
 
                           time_point: "2019-01-14T17:00:00Z+08:00",      ## 观测时间和时区信息
 
 
                           quality:      "轻度污染",                        ## 空气污染等级,自然语言描述(中文)
 
                           quality:      "轻度污染",                        ## 空气污染等级,自然语言描述(中文)
 
                           primary_pollutant: "细颗粒物(PM2.5)",            ## 主要污染物(中文)
 
                           primary_pollutant: "细颗粒物(PM2.5)",            ## 主要污染物(中文)
 
 
                           pm25:         "91",                              ## 细颗粒污染[μg/m3],缺测为“null”
 
                           pm25:         "91",                              ## 细颗粒污染[μg/m3],缺测为“null”
 
                           pm10:         "134",                              ## 粗颗粒污染[μg/m3],缺测为“null”
 
                           pm10:         "134",                              ## 粗颗粒污染[μg/m3],缺测为“null”
Line 34: Line 37:
 
                           so2:         "8",                                ## 二氧化硫[μg/m3],缺测为“null”
 
                           so2:         "8",                                ## 二氧化硫[μg/m3],缺测为“null”
 
                           co:         "1.1",                              ## 一氧化碳[mg/m3],缺测为“null”
 
                           co:         "1.1",                              ## 一氧化碳[mg/m3],缺测为“null”
                           aqi:         "120"                              ## AQI(国标)
+
                           aqi:         "120"                              ## AQI(中国自然资源部,国标)
 
                       },
 
                       },
 
             0000A02317:{...},
 
             0000A02317:{...},
 
             ...
 
             ...
 
         }
 
         }
 +
}
 
</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:{...},
             ...
         }
}