Difference between revisions of "空气污染实况城市排名接口"

From CaiyunWiki
Jump to: navigation, search
(返回结构和说明)
(请求样例)
 
(15 intermediate revisions by the same user not shown)
Line 11: Line 11:
  
 
=='''请求样例'''==
 
=='''请求样例'''==
<blockquote>http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25<nowiki/>&type=desc&number=10</blockquote>'''参数:'''
+
<blockquote>http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN</blockquote><blockquote>[http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25&type=desc&number=10 http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25<nowiki/>&type=desc&number=10]</blockquote><blockquote>'''field 排名所用的变量:'''【'pm25', 'pm10', 'o3', 'no2', 'so2', 'co', 'aqi'】,默认pm25</blockquote><blockquote>'''type 排名所用的变量:'''【'asc', 'desc'】,默认asc(空气质量好的城市排名靠前)</blockquote><blockquote>'''number 排名返回的城市数量:'''<=200,默认100</blockquote>
 
 
'''field 排名所用的变量:'''【'pm25', 'pm10', 'o3', 'no2', 'so2', 'co', 'aqi'】,默认pm25
 
 
 
'''type 排名所用的变量:'''【'asc', 'desc'】,默认asc(空气质量好的城市排名靠前)
 
 
 
'''number 排名返回的城市数量:'''<=200,默认100
 
  
 
=='''返回结构和说明'''==
 
=='''返回结构和说明'''==
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
  
 +
{
 
status:     ok
 
status:     ok
 
category:    aqi_latest_obs_city_ranking
 
category:    aqi_latest_obs_city_ranking
result: {
+
result: [                                                    ##value为list类型,按照排名次序顺次排列
        0:{
+
          {
 
               station_code:    "0000A01496",                ## 彩云全球雾霾站点编号(10位字符串)
 
               station_code:    "0000A01496",                ## 彩云全球雾霾站点编号(10位字符串)
 
               area:            "乌鲁木齐市",                ## 站点所在城市、城区、县级名称(中文或者英文)
 
               area:            "乌鲁木齐市",                ## 站点所在城市、城区、县级名称(中文或者英文)
               lon: "87.6444",
+
               lon:             "87.6444",
 
               lat:            "43.962",                    ## 经纬度
 
               lat:            "43.962",                    ## 经纬度
 
               time_point:      "2019-01-15T12:00:00Z+08:00", ## 观测时间和时区信息
 
               time_point:      "2019-01-15T12:00:00Z+08:00", ## 观测时间和时区信息
  
               primary_pollutant: "细颗粒物(PM2.5)",
+
              quality:                 "严重污染",          ## 空气污染等级,自然语言描述(中文)
              quality: "严重污染",
+
               primary_pollutant:       "细颗粒物(PM2.5)",   ## 主要污染物(中文)
  
               pm25:            "355",                         ## 细颗粒污染[μg/m3],缺测为“null”
+
               pm25:            "355",                       ## 细颗粒污染[μg/m3],缺测为“null”
               pm10:            "389",                         ## 粗颗粒污染[μg/m3],缺测为“null”
+
               pm10:            "389",                       ## 粗颗粒污染[μg/m3],缺测为“null”
               o3: "20",                         ## 臭氧[μg/m3],缺测为“null”
+
               o3:             "20",                         ## 臭氧[μg/m3],缺测为“null”
               no2: "88",                         ## 二氧化氮[μg/m3],缺测为“null”
+
               no2:             "88",                         ## 二氧化氮[μg/m3],缺测为“null”
               so2: "20",                         ## 二氧化硫[μg/m3],缺测为“null”
+
               so2:             "20",                         ## 二氧化硫[μg/m3],缺测为“null”
               co: "4.8",                         ## 一氧化碳[mg/m3],缺测为“null”
+
               co:             "4.8",                       ## 一氧化碳[mg/m3],缺测为“null”
               aqi: "404"                         ## AQI(中国自然资源部,国标)
+
               aqi:             "404"                         ## AQI(中国自然资源部,国标)
            },
+
          },
        1: {...},
+
          {...},
 +
            ...
 +
        ]
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:API 产品]]
 
[[Category:API 产品]]

Latest revision as of 05:57, 15 January 2019

授权与认证

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

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

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

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

请求样例

http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN
http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25&type=desc&number=10
field 排名所用的变量:【'pm25', 'pm10', 'o3', 'no2', 'so2', 'co', 'aqi'】,默认pm25
type 排名所用的变量:【'asc', 'desc'】,默认asc(空气质量好的城市排名靠前)
number 排名返回的城市数量:<=200,默认100

返回结构和说明

{
status:	     ok
category:    aqi_latest_obs_city_ranking
result:	[                                                     ##value为list类型按照排名次序顺次排列
          {
               station_code:    "0000A01496",                 ## 彩云全球雾霾站点编号10位字符串
               area:            "乌鲁木齐市",                 ## 站点所在城市城区县级名称中文或者英文
               lon:             "87.6444",
               lat:             "43.962",                     ## 经纬度
               time_point:      "2019-01-15T12:00:00Z+08:00", ## 观测时间和时区信息

               quality:	                "严重污染",           ## 空气污染等级自然语言描述中文
               primary_pollutant:       "细颗粒物(PM2.5)",    ## 主要污染物中文

               pm25:            "355",                        ## 细颗粒污染[μg/m3]缺测为null
               pm10:            "389",                        ## 粗颗粒污染[μg/m3]缺测为null
               o3:              "20",                         ## 臭氧[μg/m3]缺测为null
               no2:             "88",                         ## 二氧化氮[μg/m3]缺测为null
               so2:             "20",                         ## 二氧化硫[μg/m3]缺测为null
               co:              "4.8",                        ## 一氧化碳[mg/m3]缺测为null
               aqi:             "404"                         ## AQI中国自然资源部国标
           },
           {...},
            ...
        ]
}