Table of contents

• Who is this for?
• Pre-requisites?
• Quick start
• Current Release
• Status
• What's included
• Bugs and feature requests
• Community
• T&Cs

Who is this for?

The library is for developers who are integrating their existing and new applications to work with Console UI. The library helps you integrate with key components of Console UI (such as the Header and Authorization flow) to expose the full functionality of your application.

Pre-requisites

Before you start integrating your app with Console UI, you need to have the following steps finished:

• Create an entry of your App in the Developer Portal using the steps here

Quick start

The steps to start integrating your application with the Console UI as follows:

• Install the Console UI library via NPM
• Change Webpack configuration
• Initialize the header
• Subscribe to sharedAccessBundle to ensure access token has been loaded
• Use exposed axios client for api calls to get tenantId and accesstoken pre-populated.

For additional information, set to the Integrate app with Console UI recipe in the OS1 Platform documentation.

v1.0.0

The v1.0.0 release adds the following functionality:

• Add the universal header element to your application
• Integrate with the Authentication flow and obtain the access token(and other access parameters)

Status

Frameworks supported

The following languages and frameworks that are supported:

• Javascript + Webpack
  • React.js
  • Vue.js

Bugs and feature requests

Have a bug or a feature request? Please reach out to [email protected].

Community

Got any questions? Feel free to discuss it in this forum where you'll find fellow developers discussing and answering your questions.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Terms and Conditions

You can find the OS1 Platform developer Terms and Conditions here.

For licensing information, please contact us at [email protected].