OS1 Solution Developer Guide

This guide offers a step-by-step process for working with solutions. A solution is a collection of compatible apps that solve an end-to-end business workflow. For example, a delivery management solution will include all apps such as dispatch, order management, routing, facility management, and user management etc required to manage last-mile deliveries. A solution can be composed of apps developed by the organization or the core FPA apps that are available in the OS1 platform.

This guide covers the following aspects for solution development:

Register solution: Register your solution with the OS1 platform. This is a one-time process and is required to create a unique identifier for your solution. Update solution attributes: The Update Solution API allows developers to add, update or remove solution metadata and composition with a single call.

Manage solution lifecycle: Developer and Product Admins can seamlessly manage their solution through the different stages of the solution lifecycle, from the Development state to being LIVE.

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

Solution version management: Developers can create new versions of a solution, and delete development versions on the OS1 platform.

Onboarding a solution: Onboarding involves updating AAA permission files for all apps within a given solution and a given tenant.

Retrieve solution details: Use the GetSolution endpoints to retrieve a specific solution by solutionId, versionId, or listingId.