Difference between revisions of "雷达实况图API接口"

From CaiyunWiki
Jump to: navigation, search
(Created page with "<blockquote></blockquote> =='''API概述 :'''== <blockquote>雾霾区域实况图 API, 提供两个区域的pm25实况栅格图:亚洲和北美(全球两切片);</b...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
<blockquote></blockquote>
 
<blockquote></blockquote>
  
=='''API概述 :'''==
+
==API概述 ''':'''==
<blockquote>雾霾区域实况图 API, 提供两个区域的pm25实况栅格图:亚洲和北美(全球两切片);</blockquote><blockquote>API会根据经纬度范围,自动选择亚洲或北美雾霾图返回(未来会提供欧洲雾霾切片);</blockquote><blockquote>文件名为格林威治时间,提供最近48帧(47逐小时历史+实况),每60分钟更新1次(从00H:00M开始);</blockquote>
+
<blockquote>根据经纬度返回对应的实况雷达单站图和实况雷达区域拼图。</blockquote>
 
 
 
=='''授权与认证'''==
 
=='''授权与认证'''==
 
<blockquote>请先至彩云开放平台注册,注册后可以获得 token 。使用本接口,开发者token需要额外开通权限,请联系商务:api@caiyunapp.com</blockquote>
 
<blockquote>请先至彩云开放平台注册,注册后可以获得 token 。使用本接口,开发者token需要额外开通权限,请联系商务:api@caiyunapp.com</blockquote>
  
=='''请求样例'''==
+
==API请求==
<blockquote>样例一(亚洲):api.caiyunapp.com/v1/aqi/images?token=@TOKEN&lon=120&lat=20</blockquote><blockquote>样例二(北美):api.caiyunapp.com/v1/aqi/images?token=@TOKEN&lon=-120&lat=20</blockquote><blockquote>'''参数:'''</blockquote><blockquote>'''经纬度:'''经度在前,纬度在后,中间用半角逗号隔开,这里是 121.6544,25.1552;API会根据经纬度范围,自动选择亚洲或北美雾霾图返回(全球两切片)</blockquote><blockquote>'''token :'''这里是测试 token ,即 <code>TAkhjf8d1nlSlspN</code></blockquote>
 
 
 
=='''返回结构和说明'''==
 
样例一(亚洲):
 
 
<blockquote><syntaxhighlight lang="javascript">
 
 
 
{  status "ok"
 
  category "aqi_latest_obs_image"
 
  images:
 
          0:{                                                                        #历史-48h帧
 
              0: "http://cdn.caiyunapp.com/weather/pm25_rt_as_20190318_05.png",      #UTC时间
 
              1: 1552885200,                                                        #UTC时间戳
 
              2:{
 
                -10,                                                                #图片最南处纬度 lat0
 
                  60,                                                                #图片最西处经度 lon0
 
                  56,                                                                #图片最北处纬度 lat1
 
                146                                                                #图片最东处经度 lon1
 
                }
 
            },
 
          1:{...},
 
            ...
 
          47:{...}                                                                  #当前实况帧
 
}
 
 
 
</syntaxhighlight></blockquote>
 
  
样例二(北美):
+
=== 示例 ===
 +
http://api.caiyunapp.com/v1/radar/images?lon=116.427301&lat=39.902451&level=1&token=TOKEN
  
<blockquote><syntaxhighlight lang="javascript">
+
=== '''请求参数:''' ===
 +
* lon:必须,无缺省值,经度。
 +
* lat:必须,无缺省值,纬度。
 +
* level:  雷达图的类型,缺省值为1。1 代表单站图,2 代表区域拼图。
 +
* token :必须,无缺省值,token。
  
{ status "ok"
+
==API 返回结果==
  category "aqi_latest_obs_image"
+
<syntaxhighlight lang="yaml">
  images:
+
{
          0:{                                                                        #历史-48h帧
+
    status: "ok",                  #请求的状态
              0: "http://cdn.caiyunapp.com/weather/pm25_rt_na_20190318_05.png"       #UTC时间
+
    timezone: "Asia/Shanghai",      #时区
              1: 1552885200                                                          #UTC时间戳
+
    tzshift: 28800,                #时区的偏移秒数,如东八区就是 28800 秒
              2:{
+
    station: "CN01",                #单站雷达的站点编号或者区域拼图的编号
                  15,                                                               #图片最南处纬度 lat0
+
    images: [                      #雷达图的列表
                -169,                                                               #图片最西处经度 lon0
+
        [   
                  71.5,                                                             #图片最北处纬度 lat1
+
"http://cdn.caiyunapp.com/res/storm_radar/radar_CN01_nmc_fast/202005191207.png", # 雷达图片的url
                   -52                                                                #图片最东处经度 lon1
+
        1589861276,                #雷达图的时间戳
                }
+
        [
            },
+
        3.9079,                   #雷达图的西南角的纬度
          1:{...},
+
        71.9282,                   #雷达图的西南角的经度 
            ...
+
        57.9079,                   #雷达图的东北角的纬度
          47:{...}                                                                  #当前实况帧
+
        134.8656                   #雷达图的东北角的经度
 +
        ],
 +
      [...],
 +
      [...],
 +
    ],
 
}
 
}
 +
</syntaxhighlight>
  
</syntaxhighlight></blockquote>
+
=== '''备注:''' ===
 +
* 雷达图的 URL 如果没有 domain,请使用 http[s]://cdn.caiyunapp.com

Latest revision as of 08:36, 19 May 2020

API概述

根据经纬度返回对应的实况雷达单站图和实况雷达区域拼图。

授权与认证

请先至彩云开放平台注册,注册后可以获得 token 。使用本接口,开发者token需要额外开通权限,请联系商务:api@caiyunapp.com

API请求

示例

http://api.caiyunapp.com/v1/radar/images?lon=116.427301&lat=39.902451&level=1&token=TOKEN

请求参数:

  • lon:必须,无缺省值,经度。
  • lat:必须,无缺省值,纬度。
  • level: 雷达图的类型,缺省值为1。1 代表单站图,2 代表区域拼图。
  • token :必须,无缺省值,token。

API 返回结果

{
    status: "ok",                   #请求的状态
    timezone: "Asia/Shanghai",      #时区
    tzshift: 28800,                 #时区的偏移秒数,如东八区就是 28800 秒
    station: "CN01",                #单站雷达的站点编号或者区域拼图的编号
    images: [                       #雷达图的列表
        [    
 "http://cdn.caiyunapp.com/res/storm_radar/radar_CN01_nmc_fast/202005191207.png", # 雷达图片的url
        1589861276,                 #雷达图的时间戳
        [
         3.9079,                    #雷达图的西南角的纬度
         71.9282,                   #雷达图的西南角的经度  
         57.9079,                   #雷达图的东北角的纬度
         134.8656                   #雷达图的东北角的经度
        ],
       [...],
       [...],
    ],
}

备注:

  • 雷达图的 URL 如果没有 domain,请使用 http[s]://cdn.caiyunapp.com