Getting started with xAPI Provider

The xAPI Provider Portal Page is a tool to customize the structure of the xAPI statement for your clients to suit your system's needs. Learners will be able to select your provider when setting up a new xAPI integration, which will structure their xAPI statements based on the preferences you select here.

NOTE: This page is intended for clients that serve a large array of customers (HRIS systems, LMS, etc.) A majority of clients should look at the Getting Started with xAPI page to setup a basic xAPI integration with Pluralsight.

Setting up a new xAPI Provider

  1. In order to add a new xAPI provider, navigate to the xAPI Portal Provider Page, and enter in your api key. For API Key information and best practices please refer to this page. Note: you must have a PARTNER key in order to gain access. To request one, please contact your CSM.

  2. Click the Add button on the top right of the table, a modal will then open. Note: we only allow one provider per company.

  3. Fill out the required information in the modal.

    • Name: A custom name for your xAPI provider.

    • Status: Determines whether your provider is active or not. If provider is set to Disabled, your provider will not show as an option in the xAPI Portal dropdown for your clients.

    • Object ID: Determines whether to use the Course IDor the Course URI for the object ID.

      • Course ID: This field is associated with the ID field from the courseCatalog and is a UUID
      • Course URI: This field is associated with the URI field from the courseCatalog and is a clickable link URI that contains the courseId. This is our preferred method of object identification for xAPI.

    • Actor Identification: Determines whether you want to use email or a SSO Identifier to identifiy a user. Here's an example of how they are structured within the statement:

      • Email Structure: "actor": { "mbox": "mailto:[email protected]" }
      • SSO Identifier Structure: "actor": { "account": { "name": "example-sso-identifier" } }

  4. Click the Add Provider button. Your xAPI provider is now available to clients when they set up their xAPI integration.

Test your xAPI Provider

  • Navigate to the section called Test your xAPI Provider. This tool allows you to send a fake xAPI statement to your integration, and also allows you to see the response message from the provider. Enter in the Statement URL, Authorization URL, Client ID and Client Secret to test your provider. These values are not saved, and will only survive for the duration of the window being open. To save your test environment, navigate to the xAPI Portal Provider Page to create/test an integration there. If you need to customize the values in the fake statement, click on the Edit test xAPI statement values to edit. This tool should be used for testing and troubleshooting purposes only.