Integration Sandbox
The sandbox environment is a testing environment that allows you to test your integration before going live. It is a sandboxed environment that is isolated from the production environment.
Getting Started
To get started, you will need to populate the partner portal to completion and then request access to the sandbox environment using the service desk. Any incomplete fields in the partner portal will prevent you from accessing the sandbox environment and introduce delays in the request.
oAuth Video Requirement
As part of the sandbox environment request, you will need to provide a video recording of the oAuth flow. This video will be used to verify that the oAuth flow is working correctly and that the integration is working as expected.
The video should be a screen recording of the oAuth flow from the start to the end. It should include the following:
- The oAuth flow from the start to the end, starting at the Partner Portal > Integrations page by using the "Test" button for the integration.
- The oAuth flow should include the following:
- Showing /v1/authorize rendering a web login / authorization flow
- Showing /v1/token cURL response with valid tokens / expirations
POS API
Populate the POS API integration details in the partner portal with the following information:
- API URL
- Client ID
- Client Secret
Retrieve the webhook secret from the partner portal and store it in your environment variables securely.
DSP API
Populate the DSP API integration details in the partner portal with the following information:
- API URL
- Client ID
- Client Secret
Retrieve the webhook secret from the partner portal and store it in your environment variables securely.
Events API
Populate the Events API integration details in the partner portal with the following information:
- API URL
- Webhook Secret
Retrieve the webhook secret from the partner portal and store it in your environment variables securely.