Description
Integrating CloudShare with other systems helps create a seamless flow of data between CloudShare and other existing platforms. For example, CloudShare can be connected to learning management systems, identity providers for single sign on, CRM or marketing tools, and custom applications using APIs and webhooks. With these integrations in place, people can launch CloudShare experiences directly from external systems, and CloudShare can return usage and progression data for reporting and automation.
Most companies start by deciding which platform will be the system of record for users and classes and then configure CloudShare to receive launches, map users, and return results. CloudShare provides an Integration area in the console where you define these connections and manage credentials, callbacks, and synchronization settings.
For detailed instructions on how to integrate with CloudShare, refer to Integrating with CloudShare.
Best Practices – Integrating with CloudShare
Set Up Independent Non-Personal User Accounts for API Usage
For production level code that interacts with the CloudShare API, API credentials are defined as part of a regular project member user account. To support this, it is recommended to set up a non-personal account and define API credentials for that user. Depending on how restrictive access needs to be, several API users can be defined based on project and user role, granting the least privileged access required.
Understand the Differences Between the v3 and v4 APIs
As of this writing, CloudShare has two admin interfaces for the CloudShare platform: Classic and Accelerate. Using the Classic admin interface will only require the v3 API (see https://docs.cloudshare.com/). Use of the Accelerate admin interface may require both the v3 and v4 APIs (see https://cloudshare.stoplight.io/docs/AccelerateAPI). The same API_ID and API_Key for the API user are used in both API versions; however, the authentication mechanisms are entirely different, and the code should account for these differences.
Note: The Accelerate platform updates how project members create and modify experiences, such as Training Classes or Sales Enablement PoCs. The v4 API, therefore, currently only supports experience creation and modification. Additional API calls that would retrieve or modify infrastructure (such as blueprints, environments or virtual machines) or other project management tasks will still require the v3 API. Integrate the LMS
CloudShare can be integrated with any LMS that uses LTI 1.1 or 1.3, or more natively with Docebo. These integrations provide a smoother user experience, allowing users to launch a CloudShare experience directly from the LMS. With LTI 1.3 and Docebo integrations and Guided Journeys, we can also provide feedback on the user's progression within an experience to the LMS.