OSRAM Sylvania 向开发者开放 Lightify REST API

  • Kevin Farnham
  • 大愚若智

2016 年 6 月 1 日

话题:移动语言 & 开发架构

OSRAM Sylvania 最近宣布将为开发者社区提供开放的 Lightify REST API,开发者可将其集成于自己的 iOS 和 Android 应用,以及网站中Lightify是一种涵盖硬件、云,以及移动设备的物联网(IoT)体系,通过 OSRAM 的 iOS 和 Android 免费应用,可以使用移动服务控制 Lightify LED 灯泡的灯光。

例如,最近有人使用 Lightify为欧洲歌唱大赛(Eurovision Song Contest)增色添彩:瑞典斯德哥尔摩的七座地标式建筑通过不同色彩体现电视观众对歌唱大赛中不同歌曲的喜好程度。其中一些地标建筑的灯光甚至通过视频进行了在线直播。

Lightify API 最初只包含在供用户免费使用的 OSRAM 应用中,不同地区用户可通过下列两个链接获取:https://eu.lightify-api.org(适合位于欧洲或周边地区的用户),以及https://us.lightify-api.org(适合位于美国、加拿大和澳大利亚或周边地区的用户)。需要说明的是,下文有关 Lightify API 的所有介绍信息全部基于后者。

Lightify API 网站提供了下列内容:

  • Home API 细节
  • 范例应用
  • 用户指南

Home API 细节提供了指向LIGHTIFY API (REST)文档的链接,其中列出了可用资源(API 端点和方法)以及数据类型(JSON)。

点击范例应用链接将显示 2.0 版 Apache License 许可。拖到页面底部点击“我同意”按钮后,网站会感谢您接受许可协议,随后便可下载软件。范例应用软件提供了三种格式(均可以 Zip 文件的形式下载):

  • Windows(EXE):Windows 应用程序LightifyApp-1.0.0.exe,运行后可启动 Java(如果 Java 版本太老则需升级)并运行范例应用。
  • JAR:Java 归档文件LightifyApp-1.0.0.jar,如果想自行开发 Lightify 应用或网站,可从这个文件入手学习。
  • 源代码LightifyHomeApp-Src-1.0.zip文件,解压缩后可获得LightifyApp子目录,该目录中包含一个 src 子目录,以及OSRAMlicense.txtpom.xmluserconfig.yaml三个文件。

用户指南链接可以打开一个五页长度的 PDF 文件《LIGHTIFY Home:云 REST API 上手指南》,该文档提供了有关 Lightify API 的更多细节,以及调用和结果范例与“常用命令”。

如果打算自行开发 Lightify 应用程序,可以首先从 OSRAM 许可(文件OSRAMlicense.txt)着手。该文档包含了《LIGHTIFY Home:云 REST API 使用条款》,同意条款后即可使用 Lightify API。开发者需要重点查阅的内容位于“I. 许可授予和使用策略”一节:

在开发您自己的应用时,为将不必要的网络流量降至最低,请尽量减少轮询的使用,例如,请确保:(i)您的应用只在用户使用应用的过程中进行轮询,(ii)如果用户最大闲置时间超过十五(15)分钟,轮询将被断开,以及(iii)您的应用针对每个网关执行轮询的平均频率不应超过每三(3)秒一次。

开发者可以在新应用程序中免费使用 Lightify API,由于所有 Lightify 应用都将免费访问 OSRAM 的 Lightify 云,只有在新应用对 API 的使用能进行自我调节限流(Self-imposed throttling)的情况下,开发者才能使用这一开放式 API。这种调节适用于您应用的某一具体用户:他们下载的应用必须包含所需的调节限流机制。目前对于您应用的所有用户产生的 Lightify 云累加用量尚不进行限制。

查看英文原文OSRAM Sylvania Opens Lightify REST API to Developers

移动语言 & 开发架构