Difference between revisions of "彩云天气 API"

From Caiyun Wiki
Jump to: navigation, search
m (可靠的后端服务)
 
(168 intermediate revisions by 5 users not shown)
Line 1: Line 1:
API是开发者和企业用户获得彩云天气数据的主要渠道,本文档由彩云算法二组负责维护,从技术开发和应用角度,全面说明彩云天气API的外延和内涵。
+
{{导览}}
  
内容还在不断完善中...
+
天气 API 是彩云天气开发者获得天气预报数据的技术方式。
  
=='''版本状态:'''==
+
== 别犹豫,立刻上手 ==
  
* [[彩云天气 API 的版本策略]]
+
<code>TAkhjf8d1nlSlspN</code>是我们这里的演示 Token,请在您的开发环境和线上环境中使用您自己的 Token,仅需在'''[https://dashboard.caiyunapp.com/user/sign_up/ 开放平台]'''轻松注册,立马可得。
* [[彩云天气 API/v2.2]]:当前版本(default:v2)
 
* [[彩云天气 API/v2.3]]:Beta(功能和接口形态稳定,还存在bug)
 
* 彩云天气 API/v2.4:Alpha(功能和接口形态还不稳定)
 
  
=='''接口类型:'''==
+
* [[通用预报接口/v2.5|通用预报接口]]
API 包含了如下几个时间级别的接口:
+
** 纽约:<code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial</code>
  
* [[实况天气接口]]
+
== 联系我们 ==
* [[分钟级降雨预报接口]]
 
* [[逐小时预报接口]]
 
* [[逐日预报接口]]
 
* [[通用预报接口]]
 
  
=='''开发者反馈渠道:'''==
+
Email: [mailto:api@caiyunapp.com api@caiyunapp.com]
 +
 
 +
如果您在使用本文档或使用 API 过程中遇到问题,请联系我们。
 +
 
 +
== 业务场景 ==
 +
 
 +
=== 天气应用 ===
 +
 
 +
[[File:SmartphoneApp.jpg|235px|right|thumb|Weather apps]]
 +
 
 +
'''分钟级降雨预报''':
 +
 
 +
* 旧金山联合广场未来 2 小时: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-122.4075,37.7879/weather.json?lang=en_US&granu=minutely</code>
 +
 
 +
'''全球覆盖''':
 +
 
 +
* 加德满都: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/85.3240,27.7172/weather.json?lang=en_US&unit=imperial</code>
 +
* 法兰克福: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/8.6821,50.1109/weather.json?lang=en_US&unit=imperial</code>
 +
* 纽约: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-74.0059,40.7128/weather.json?lang=en_US&unit=imperial</code>
 +
* 夏威夷: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-157.8583,21.3069/weather.json?lang=en_US&unit=imperial</code>
 +
* 悉尼: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/151.2093,-33.8688/weather.json?lang=en_US&unit=imperial</code>
 +
* 开普敦: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/18.4241,-33.9249/weather.json?lang=en_US&unit=imperial</code>
 +
 
 +
[[File:Autumn Drone.jpg|235px|right|thumb|Drone controlling]]
 +
 
 +
'''多语言支持''':
 +
 
 +
* 东京: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/139.7690,35.6804/weather.json?lang=ja</code>
 +
* 北京: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/116.4074,39.9042/weather.json?lang=zh_CN</code>
 +
 
 +
'''多单位制式的支持''':
 +
 
 +
* 巴黎: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/2.3522,48.8566/weather.json?lang=en_US&unit=metric</code>
 +
* 悉尼: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/151.2093,-33.8688/weather.json?lang=en_US&unit=imperial</code>
 +
 
 +
'''全球日出日落''':
 +
 
 +
* 伦敦: <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/0.1278,51.5074/weather.json?lang=en_US&granu=daily&fields=astro</code>
 +
 
 +
=== 系统控制与 IoT 场景 ===
 +
 
 +
在系统控制的场景里,您可能需要科学单位制的支持,同时数据也往往只需要实时数据,您可以这样调用
 +
 
 +
* <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-157.8583,21.3069/weather.json?lang=en_US&unit=SI&granu=realtime</code>
 +
 
 +
=== 规划与计划 ===
 +
 
 +
* 短期: 24 小时的小时级预报
 +
** <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial&granu=hourly&hourlysteps=24</code>
 +
* 长期: 10 天的天级别预报
 +
** <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/139.7690,35.6804/weather.json?lang=ja&granu=daily&dailysteps=10</code>
 +
 
 +
=== Web 应用 ===
 +
 
 +
这种场合下,我们需要 '''jsonp''' 的支持
 +
* 如果 jsonp callback 是 <code>check_weather</code>
 +
** <code>https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-157.8583,21.3069/weather.jsonp?lang=en_US&callback=check_weather</code>
 +
 
 +
 
 +
== 全球服务 ==
 +
 
 +
[[File:2020.3 彩云天气高精度数据覆盖范围.png|thumb|分钟级降雨的全球覆盖情况]]
 +
 
 +
=== 国际化支持 ===
 +
 
 +
* 日期与时间计算会影响 avg/max/min 天气变量的值的统计,我们的 API 充分考虑了国际化场景的计算需求
 +
* 我们支持不同的单位制,包括 [https://en.wikipedia.org/wiki/Metric_system 公制], [https://en.wikipedia.org/wiki/Imperial_and_US_customary_measurement_systems 英制] 和 [https://en.wikipedia.org/wiki/International_System_of_Units 国际单位制]
 +
* 我们在中文、英语和日语上支持天气的简短描述。
 +
 
 +
=== 通用天气预报的全球覆盖 ===
 +
 
 +
* 从 2015 年 API 服务上线起,我们就支持全球范围的通用天气预报查询。
 +
 
 +
=== 分钟级降雨的覆盖情况  ===
 +
 
 +
我们是唯一的一家能在全球范围内提供分钟级降雨服务的提供商,在[[{{FULLPAGENAME}}#附录一:分钟级降雨的覆盖情况表|下表中]]有详细说明。
 +
 
 +
=== 雾霾预报的覆盖情况 ===
 +
 
 +
目前仅覆盖中国全境。
 +
 
 +
== API 特性 ==
 +
 
 +
=== 丰富的变量支持 ===
 +
 
 +
在如下[[{{FULLPAGENAME}}#附录二:变量表|变量表]]中给出了详细说明。
 +
 
 +
=== 分钟级短临降雨预报  ===
 +
 
 +
我么提供两种途径的分钟级短临降雨预报的数据接口
 +
 
 +
* 按照经纬度的点式调用
 +
* 预报的雷达图的图片或者数据
 +
 
 +
== AI 算法 ==
 +
 
 +
从 2014 年成立以来,我们一直关注预报精度,不断迭代改进算法。
 +
 
 +
{| style="margin-left: auto; margin-right: auto; border: none;"
 +
|- style="vertical-align: top"
 +
| [[File:Caiyun Intro.009.jpeg|thumb|第 1 代雷达图去噪算法]]
 +
| [[File:Caiyun Intro.011.jpeg|thumb|第 3代短临降雨预报算法]]
 +
| [[File:Caiyun Intro.013.jpeg|thumb|第 1 代和第 2 代空气质量预报的对比]]
 +
|}
 +
 
 +
==  可靠的后端服务 ==
 +
 
 +
* 可扩展性:共有服务池每日可提供 3~8 亿次 API 调用,并且在大需求量情况下可以轻松扩展
 +
* 稳定性:过去一年的系统可用性在 99.99% 的水平
 +
 
 +
{| style="margin-left: auto; margin-right: auto; border: none;"
 +
|- style="vertical-align: top"
 +
| [[File:Caiyun Intro.015.jpeg|thumb|性能与可用性监控平台]]
 +
| [[File:Caiyun Intro.016.jpeg|thumb|背后的技术架构]]
 +
|}
 +
 
 +
我们可以为大需求量客户提供更好可用性的私有服务池。
 +
 
 +
==  背后的团队 ==
 +
 
 +
{| style="margin-left: auto; margin-right: auto; border: none;"
 +
|- style="vertical-align: top"
 +
| [[File:Caiyun Intro.008.jpeg|thumb|年会后部分同事的合影]]
 +
| [[File:彩云小史.011.jpeg|thumb|工作环境一瞥]]
 +
|}
 +
 
 +
== 给我们提建议 ==
 +
* 请求新功能:[https://trello.com/b/RRa3flng/ 你要新功能,比如你要火星天气预报,点击这里]
 +
* Bug 回报:[https://trello.com/b/z62UnLlw/ 出现故障,比如 api 无法访问或者某处温度变成 -300,点击这里]
 +
* [[彩云天气 API/v2.5| 彩云天气常见问题]]
 +
* [[联系我们]]
  
* [https://trello.com/b/RRa3flng/ 新的公开特性请求]
 
* [https://trello.com/b/z62UnLlw/ 线上版本BUG反馈]
 
  
 
[[Category:API 产品]]
 
[[Category:API 产品]]
 +
 +
[[en:ColorfulClouds Weather API]]

Latest revision as of 06:21, 15 December 2020

快速通道:天气业务 | 天气开发者 | 小译开发者

天气 API 是彩云天气开发者获得天气预报数据的技术方式。

别犹豫,立刻上手

TAkhjf8d1nlSlspN是我们这里的演示 Token,请在您的开发环境和线上环境中使用您自己的 Token,仅需在开放平台轻松注册,立马可得。

联系我们

Email: api@caiyunapp.com

如果您在使用本文档或使用 API 过程中遇到问题,请联系我们。

业务场景

天气应用

Weather apps

分钟级降雨预报:

全球覆盖:

Drone controlling

多语言支持:

多单位制式的支持:

全球日出日落:

系统控制与 IoT 场景

在系统控制的场景里,您可能需要科学单位制的支持,同时数据也往往只需要实时数据,您可以这样调用

规划与计划

Web 应用

这种场合下,我们需要 jsonp 的支持


全球服务

分钟级降雨的全球覆盖情况

国际化支持

  • 日期与时间计算会影响 avg/max/min 天气变量的值的统计,我们的 API 充分考虑了国际化场景的计算需求
  • 我们支持不同的单位制,包括 公制, 英制国际单位制
  • 我们在中文、英语和日语上支持天气的简短描述。

通用天气预报的全球覆盖

  • 从 2015 年 API 服务上线起,我们就支持全球范围的通用天气预报查询。

分钟级降雨的覆盖情况

我们是唯一的一家能在全球范围内提供分钟级降雨服务的提供商,在下表中有详细说明。

雾霾预报的覆盖情况

目前仅覆盖中国全境。

API 特性

丰富的变量支持

在如下变量表中给出了详细说明。

分钟级短临降雨预报

我么提供两种途径的分钟级短临降雨预报的数据接口

  • 按照经纬度的点式调用
  • 预报的雷达图的图片或者数据

AI 算法

从 2014 年成立以来,我们一直关注预报精度,不断迭代改进算法。

第 1 代雷达图去噪算法
第 3代短临降雨预报算法
第 1 代和第 2 代空气质量预报的对比

可靠的后端服务

  • 可扩展性:共有服务池每日可提供 3~8 亿次 API 调用,并且在大需求量情况下可以轻松扩展
  • 稳定性:过去一年的系统可用性在 99.99% 的水平
性能与可用性监控平台
背后的技术架构

我们可以为大需求量客户提供更好可用性的私有服务池。

背后的团队

年会后部分同事的合影
工作环境一瞥

给我们提建议