Quick Start
Obtain your Credentials

4min
Overview
In this guide, you'll learn how to register your first application with OS1. You have the flexibility to register your app either using the API or through the Developer Portal. Additionally, you'll learn how to retrieve and use your platform credentials. For more details, refer to the  Apps and Solutions concept chapter.
Step 1: Register your App
Registering an app with OS1 can be done easily using either the API or the Developer Portal. Follow these steps to get your app registered and ready for integration on the platform.
Developers can register their applications via API by calling the RegisterApp endpoint. Follow the steps below to register an web app:
Prepare the application details JSON based on the RegisterApp parameters.
Set the required parameters like displayName, type, listingId, version, isConsoleCompatible, shortDescription, categories, and menu.
Make a POST request to the endpoint RegisterApp with the application details JSON
The API will validate the details and register the app. 
On success, the API returns a 201 status code with the registered application details
The application will now be available in the Developer Portal.
Example Request
Register web app
{
	"displayName": "Truck Tracker",
	"type": "WEB", 
	"listingId": "truck-trackers",
	"version": "1.0.2",
	"isConsoleCompatible": true,
	"isPrivate": true,
	"url": {
		"relativePath": "truck-trackers",
		"stackId": "*",
		"server": "your-kubernetes-cluster.svc.cluster.local",
		"interface": "/",
		"admin": "admin",
		"setting": "settings",
		"userGuide": "docs",
		"gitInfo": "https://github.com/your-org/your-repo"
	},
	"shortDescription": "A truck tracker that allows you to track your trucks.",
	"longDescription": "Dig deep into the details of your truck maintenance schedules as well as locations. Receive notifications when a vehicle hits a maintenance milestone.",
	"categories": [
		"vehicle",
		"tracking"
	],
	"menu": [{
		"displayName": "Inventory",
		"displayOrder": 4,
		"relativePath": "inventory"
	}],
     "packageName": "com.example.vehicletracker"
}
{
	"displayName": "Truck Tracker",
	"type": "WEB", 
	"listingId": "truck-trackers",
	"version": "1.0.2",
	"isConsoleCompatible": true,
	"isPrivate": true,
	"url": {
		"relativePath": "truck-trackers",
		"stackId": "*",
		"server": "your-kubernetes-cluster.svc.cluster.local",
		"interface": "/",
		"admin": "admin",
		"setting": "settings",
		"userGuide": "docs",
		"gitInfo": "https://github.com/your-org/your-repo"
	},
	"shortDescription": "A truck tracker that allows you to track your trucks.",
	"longDescription": "Dig deep into the details of your truck maintenance schedules as well as locations. Receive notifications when a vehicle hits a maintenance milestone.",
	"categories": [
		"vehicle",
		"tracking"
	],
	"menu": [{
		"displayName": "Inventory",
		"displayOrder": 4,
		"relativePath": "inventory"
	}],
     "packageName": "com.example.vehicletracker"
}
﻿
﻿
﻿
After setting up your team, it’s time to register your app. Follow the steps below:
Sign in to the OS1 developer portal.
From the left navigation pane, select Apps.
Click Create your First App.
Fill in the following required information for your app:
App Listing Name: The name of your app
App Type: Web, Mobile, or Backend. 
Description: A short description of the app
Version: The version of your app using semantic versioning formatting.
Web Apps: If you’re creating a Web app, complete the following information:
5. The relative path of the app landing page. This path will be used to form the final URL while rendering the app from the console. For example: _https://tenantaname.myorg.com/application/MyOrgApp/ _
Select Console Compatible to make the app compatible with the console app launch experience.
Click Register App to submit the registration.
﻿Accessing Web Apps from the Console﻿
After you register a Web app, you’ll be able to access them in the Console UI using the tenant ID and your console URL: https://tenantname.sandbox.getos1.com.
﻿
The registration process may take a few minutes to complete. Once your app is successfully registered, you will be redirected to the Apps overview page. This page contains your app's credentials, which include your Client ID, Client Secret, Tenant URL, and Tenant ID.
﻿
Step 1: Obtain Credentials
To authenticate your apps on the platform, you need to obtain your credentials. You can access your credentials either through the API or the OS1 Developer Portal. However, keep in mind that your app must pass the tech review and have at least one approved version to get your credentials.
Prerequisites: Application registered on OS1 platform with ID {appId}
Get the appId value for your application. You can find this in the RegisterApp response. 
Call GetProdCredentials with your appId.
The JSON response contains your application's production credentials.
Use the clientId and clientSecret to authenticate your production application requests to OS1 APIs.
JSON
{
  "clientId": "{client-id}", 
  "clientSecret": "{client-secret}" 
}
{
  "clientId": "{client-id}", 
  "clientSecret": "{client-secret}" 
}
﻿
View Credentials in Developer Portal
﻿
Service and Frontend: If you register one Web app type you will receive credentials for backend and frontend.
Service (backend): Use the Client ID and Client Secret in your backend to generate access tokens and make API calls on the platform.
Frontend (Mobile/Web): Use the front-end credentials within your front-end with Authentication And Authorization(AAA) SDK to generate an OTP that gives your users access to the platform resources through your UI.
﻿
Updated 18 Sep 2024
Did this page help you?
Make your First API Call
Asynchronous APIs
Obtain your Credentials

Overview

Step 1: Register your App

Using the API

Using the Developer Portal

Step 1: Obtain Credentials

Retrieve Credentials Via the API

View Credentials in Developer Portal
