Preamble

Welcome to the Rainbow Web Software Development Kit!

The Rainbow Web SDK (Software Development Kit) is a pure JavaScript library that works on all modern supported browsers (see the list below). Its powerful APIs enable you to create the best Web applications that connect to the Rainbow Cloud Services.

Read this documentation in order to know how to install and use the Rainbow SDK for Web.

Install

npm i -S rainbow-web-sdk

Rainbow SDK for Web libraries are located in the following directory your_project/node_modules/rainbow-web-sdk/src/.

SDK Support

For issues, improvements or new API requests feel free to ask the Rainbow support via our website: https://developers.openrainbow.com/.

Environment

The Rainbow SDK for Web depends on AngularJS, jQuery and Moment. These libraries have to be loaded. See the tutorials section for more details.

The Rainbow SDK for Web works on:

• Chrome stable channel and Chromium based browser (e.g. Opera)

• Firefox ESR and stable channel

• Microsoft Edge

• Safari

The Rainbow SDK for Web is supported on Windows (starting from Windows 7) and MacOS (Starting from 10.10).

The Rainbow SDK for Web can be integrated to any Web application (not only Angular applications, you can use it with React, Vue, jQuery or pure JavaScript projects), browser extension or desktop application that embeds a Webview (e.g. QT application, Electron, nw.js...).

Content

The Rainbow SDK for Web contains:

• The JavaScript SDK library: This file has to be included in your application from the Rainbow Sandbox platform.

• Several demo applications to demonstrate how to use the Rainbow Web SDK.

• An API documentation that describes the available APIs (that you can call from your application) and that contains some tutorials explaining the fundamental parts.

Software License

Copyright (c) 2020, Alcatel-Lucent Enterprise

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.