Getting started with building Apps

To create Apps on the OS1 Platform you need to set up an Organization and be approved for Tenant. A Tenant is a sandbox environment that provides a data-isolated development and testing environment for you to develop your own Apps and solutions. If you are not currently part of an Organization, the setup procedure guides you through the process.

After you have set up your Organization and been approved for Tenant, you can Register an App and get the associated client ID and client secret. These enable you to make API calls on the platform either as part of an App or through some other mechanism, such as Postman, while you learn more about the Platform.

To set up your Organization and development environment:

Sign in to the OS1 developer portal.
On the developer dashboard in the left-hand navigation column, select Organization.
On the Create Organization page enter the following information:
1. Acknowledge that you understand the requirements for registering an Organization.
2. Select whether the type of organization that you are registering is for you as an individual developer or as part of a business.
  1. In Email type your email address. Note: If you selected Business, this must be the email address supplied by the company.
  2. If you selected Business, in Company Name, type the name of your company.
  3. Enter your First and Last name.
  4. On the Website, type the website address.
  5. In Domain, type the name of your domain.
  6. In Country, select the name of the country in which the business is located.
Select Create Organization. The portal will send a One Time Password (OTP) to the email address that you entered.

When the Organization is successfully created, the portal creates a preliminary team for you and assigns it a default name. You can rename the team on the Organization creation success screen.

Our admins will review your information to determine whether you are eligible for a sandbox environment and contact you with the decision.

Getting and using platform credentials

To access the resources on OS1 Platform you must register an App in the developer portal. When you complete the registration, you get the Client ID, Client Secret, Tenant URL, and Tenant ID.

These credentials are used to authenticate your Apps on the platform. There are two types of Apps:

Service (backend) Apps:

These Apps use the Client ID and Client Secret to generate access tokens that you use to authenticate your API calls on the Platform.

Frontend (Mobile/Web) Apps:

These Apps use the Authentication And Authorization SDK to generate an OTP that gives your User access to the Platform resources through your App.

The Tenant URL provides the base URL for the API endpoints that you use to access the Platform.

For example, in the Get Tenant Attributes call:

https://{base_url}/core/api/v1/participants/tenants

Your Tenant URL replaces the {base_url} parameter.

The Access Token and Tenant ID are passed as request head parameters:

X-COREOS-TID: Tenant ID
X-COREOS-ACCESS: Access Token

Register an APP

To register your App:

Sign in to the OS1 developer portal.
From the left navigation bar, select Apps.
On the Apps screen, select Register Additional Apps.
On the Register App Screen:
1. In App Name, type the name of the App.
2. From the App Type dropdown, select the type of App.
3. In Description, type a short description of the App.
4. In Version, type the version number of the App x.y.z format.
5. If you selected a Web app, use the Console Compatible checkbox to indicate whether the App is compatible with the Console App launch experience.
Select Register App to submit the registration.

It takes several minutes to finish the registration process. After the App is successfully registered you can select App in the left navigation bar to view the list of your registered Apps.

To view the details of your App, including the App Id, Client ID, and Client Secret, select Details.

You can also use these credentials to try API calls on the official documentation site.

You can use the Client ID, Client Secret, and Tenant URL to try out more of the APIs. For more information, see How to use the API 'Try It' feature.

After you are comfortable with the APIs, you can start developing your App locally. When you complete development and testing you can come back and submit the app for review and publishing.