Last update:
October 26, 2023
Getting started¶
This section explains how to prepare your environment for testing xAPI.
Prerequisites¶
- VC platform 3.0 or higher.
- The platform is configured to use ElasticSearch engine.
Presettings¶
To start using xAPI:
- Open the Platform and go to Settings.
- Select Catalog.
- Select Search.
-
Enable Store serialized catalog objects in index option:
-
Rebuild index.
Test environment¶
To set up the test environment:
- Install
vc-module-experience-api
on the platform version 3.0 or higher, using this guide. - Restart the platform instance.
- Open GraphQL UI playground in the browser: http://{platform url}/ui/playground
View sample request
Authorization and token usage¶
Some GraphQL queries and mutations require addition authorization. To test the query or mutation without authorization errors:
- Open the Virto Commerce API Docs (v1) in your browser.
-
Authorize as an administrator or manager.
-
Expand
POST/connect/token
section to fill in the required fields with appropriate credentials, then click Execute. -
Copy the token that appears in the field below:
Providing token in Playground is decribed in the Playground section.
Providing token in Postman is described in Postman section.