Sandbox is TravelPerk's free self-service development environment.
You can use Sandbox as a separate environment to test integrations and make test bookings without impacting your actual TravelPerk account.
To find out which integrations are available on TravelPerk, go to Account Settings and click Integrations.
Depending on how you use Sandbox, you might need to set up some extra configurations.
Create a Sandbox Account
- Go to the Sandbox app on TravelPerk
- Enter your work email, first name and last name
- Read the Terms of Use and tick the box, then click Get Started
- Enter the details about yourself and your company and click Create Account
- You will receive a verification email in your inbox. If you don't receive the email, make sure to check your spam folder.
- Open the email and click Verify email
Sandbox settings
The Sandbox environment is set up with some fake data to help you when you are testing integrations.
You may need to set up some extra configurations, depending on how you use the tool.
For the following use cases, you can find instructions for changing the Sandbox settings below:
Note: For all the cases listed below, you'll need to upgrade your Sandbox account to Pro. Upgrading to Pro on Sandbox is free.
HR integrations
To test one of the HR integrations available on TravelPerk, follow these steps:
- Upgrade your Sandbox account to Pro - go to Account Settings, under Account, select Plans and click Pro
- To find the HR integrations, go to Account Settings and select Integrations. On the integrations you want to test, click Set up.
- Complete the setup process for the integration. For instructions, go to HR integrations.
- Once the integration has been enabled, go to the People page and you can see who was added
- Click the names of some people and check that the profile information was added correctly
Expense integrations
To test one of the expense integrations available on TravelPerk, follow these steps:
- Upgrade your Sandbox account to Pro - go to Account Settings, under Account, select Plans and click Pro
- You'll need to create a test payment profile - go to Account Settings, under Account, select Payment profiles and click Create payment profile
- Enter the details of the test card from Stripe's test card numbers
- Make sure you select the correct company - only people assigned to the selected company will have access to the payment profile
- Before creating a test booking, make sure that the people you will make the booking for have the correct settings. Go to the People page and click the person's name. In their profile, go to Preferences and settings.
- To find the expense integrations, go to Account Settings and select Integrations. On the integrations you want to test, click Set up.
- Complete the setup process for the integration. For instructions, go to Expenses integrations.
- Create a test trip
Note: The inventory available on Sandbox is sample data and will not make real bookings. You can only select specific inventory to complete the booking process. For more information, see the Developer's Guide - Booking inventory on Sandbox.
OpenAPI - Build your own integration
If we don't support the integration you need, you may consider building your own using our API and Developer's guides.
To test an Open API integration that you are building, follow these steps:
- You need to upgrade your Sandbox account to Pro - go to Account Settings, under Account select Plans and click Pro
- To get your API Key and import our Postman Collection, go to the Developer's Quick Start guide
- Depending on the integration that you are building, you can use the following API references:
- Expense API: this service allows you to access invoices and invoice lines, which can be used for many things from expense reporting to accounting.
- SCIM API: this service was created to facilitate the management of people and groups of people.
- Cost Centers API: this service enables the automatic management, creation, updating and archiving of cost centers on the TravelPerk platform.
- Trips API: this service allows you to retrieve data about canceled or confirmed bookings.
Once you have built the integration, you can create a test booking following these steps:
- You'll need to create a test payment profile - go to Account Settings, under Account select Payment profiles and click Create payment profile
- Enter the details of the test card from Stripe's test card numbers
- Make sure you select the correct Company - only people assigned to the selected Company will have access to the payment profile
- Before creating a test booking, make sure that the people you will make the booking for have the correct settings. Go to the People page and click the person's name. In their profile, go to Preferences and settings.
- To find the expense integrations, go to Account Settings and select Integrations. On the integrations, you want to test, click Set up.
- Complete the setup process for the integration - for instructions, see the Expenses integrations section of the Help Center
- Create a test trip
Note: The inventory available on Sandbox is sample data and will not make real bookings. You can only select specific inventory to complete the booking process. For more information, see the Developer's Guide - Booking inventory on Sandbox.