Publishing Integrations in the Sandbox (for partners)

The Sandbox environment allows publishing integrations to perform authorization and integration tests between a sandbox account and your application.

📘

Requirements

You need an OAuth application with an authentication interface for your application.
Ensure you are familiar with the needs reading OAuth 2.0

Publishing new Integrations

In your Sandbox environment account:

1. Go to Account settings > Integrations
2. Click on the New Integration button
3. Introduce your application information on the next page
   1. Integration name: Your application or product name
   2. Integration description: A short description of your integration that will be displayed on the integrations page as part of the integration card.
   3. Integration category: the category that fits best the use cases supported by the application.
   4. Integration logo: A URL that contains your application logo, ideally a 40x40 px transparent PNG
   5. Redirect URL: The application OAuth URL, from which users can authenticate and authorize the integration. Example /external-integrations/connect/travelperk
   6. External URL: The URL where users will be redirected here when clicking on the Enable button on the integration. The application should log the user and start the OAuth handshaking (calling the /oauth2/authorize endpoint).
   7. Scope: Select the Scopes that the application needs to access
4. Click on the "Create new Integration" button

After creating the Integration, you will see a pop-up where you can find the client id and client secret of the OAuth application. You will need them to set up the OAuth application on your side.

Click on "Ok, understood" to finish the process.
Congratulations, you have successfully created an integration in your sandbox account!

Enabling sandbox integrations

On the Integration detail page, click on the "Enable" button, this will take you to the *External URL defined above.

Complete the authorization if necessary introducing the right credentials.
The integration is enabled and ready to be used.

Editing sandbox integrations

At any moment, you can edit the settings of an application by clicking on the "Edit integration" button on the integration detail page.

Deleting sandbox integrations

To delete an application from the Integrations page, click on the "Delete integration" button on the integration details page. Confirming the action, will completely delete the application from your sandbox account.