Integrate with Participants

The following how-to sections describe the steps necessary to create Participants using the Participant API. The how-tos in this section use the example of creating a mobile device Participant to illustrate the process.

Prerequisites

• An account on the OS1 Platform and a Platform Tenant. For more information, see Getting started with the OS1 Platform.
• Credentials for an App on the OS1 Platform. For more information, see Getting started building Apps.
• An access token. For more information about creating an access token for testing purposes, see Postman Collection or How to use the API 'Try It' feature.
• A mechanism to call the endpoints. For testing purposes, you can use our Postman Collection or the “Try It!” feature in our API Documentation.

To create a Participant, you must:

• Create a Participant Type. For more information, see How to: Create a Participant Type.
• Define the Participant Attributes. For more information, see How to: Define Participant Attributes.
• Define the Participant Templates. For more information, see How to: Create a Participant Template
• Configure the state machine. For more information, see How to: Configure the state machine.
• Create the Participant. For more information, see How to: Create the Participant.

Additionally, you can:

• Change the Participant state. For more information, see How to: Change the Participant type.
• Handle Callbacks. For more information, see Working with Callbacks