OS1 App Developer’s Guide

This guide offers a step-by-step process for the app development. An app is a business logic layer built on top of APIs designed to handle specific tasks or offer particular functions, while a solution is a set of compatible apps that bring together several apps to manage a full business process.

The guide covers the following aspects of app development:

App registration: Register your app on the OS1 platform. We support web apps, mobile apps, or backend apps.

Update attributes: The Update App API allows for comprehensive updates to an app's attributes in just one API call, including the ability to add, modify, or remove attributes. Attribute removal is as simple as passing a null value, such as setting a specific appMenu item as "null."

Manage application artifacts: Developers can use the artifacts APIs to upload and manage app artifacts such as icons, images, documents, and permission files. This includes uploading, retrieving, and deleting these artifacts as needed.

Add solutions compatibility: The Add Solutions Compatibility API enables developers to easily declare their app's compatibility with one or more solutions, ensuring seamless subscription to both the app and its associated solutions.

Submit for review and manage lifecycle: Developer and product admins can seamlessly manage their apps through the different stages of the application lifecycle, from the Development state to being LIVE.

Onboarding an app: Onboarding involves uploading an AAA permissions file for an app within a given tenant.

Version management: Developers can create new versions of an app, and delete development versions on the OS1 platform.

Get application details: Retrieve the details of your application.

Get production credentials: Retrieve the production details for your application.