Sandbox is Perk’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 Perk account. 

To find out which integrations are available on Perk, go to Settings > Integrations. 

Depending on how you use Sandbox, you may need to set up additional configurations. 

Create a Sandbox Account

1. Go to the Sandbox app on Perk.
2. Enter your work email, first name, and last name.
3. Read the Terms of Use and tick the box, then click Get Started.
4. Enter the details about yourself and your company, then click Create Account.
5. You will receive a verification email in your inbox. If you don’t receive the email, make sure to check your spam folder. 
6. Open the email and click Verify email.

Sandbox settings

The Sandbox environment is set up with fake sample data to assist you during integration testing. 

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:

• HR integrations.
• Expense integrations.
• OpenAPI - Build your own integrations.

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 Perk:

1. Upgrade your Sandbox account to Pro. Go to Settings > Account > Plans and select Pro.
2. To find the HR integrations, go to Settings > Integrations. For the integration you want to test, click Start set up.
3. Complete the setup process for the integration. For instructions, go to HR integrations.
4. Once the integration has been enabled, go to the People page to view a list of people who have been added.
5. 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 Perk:

1. Upgrade your Sandbox account to Pro. Go to Settings > Account > Plans and select Pro.
2. You’ll need to create a test payment profile. Go to Settings > Account > Payment profiles and click Create payment profile.
3. Enter the details of the test card from Stripe’s test card numbers.
4. Make sure you select the correct company. Only people assigned to the selected company will have access to the payment profile.
5. Before creating a test booking, make sure that the people you will book the trip for have the correct settings. Go to the People page and click the person’s name. In their profile, go to the Organization tab.
6. To find the expense integrations, go to Settings > Integrations. On the integrations you want to test, click Start set up.
7. Complete the setup process for the integration. For instructions, go to Expenses integrations.
8. Create a test trip.

Tip: The inventory available on Sandbox is sample data and will not book real trips. 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 Perk doesn’t support the integration you need, you may consider building your own using our API and developers’ guides. 

To test an Open API integration that you are building:

1. You need to upgrade your Sandbox account to Pro. Go to Settings > Account > Plans and select Pro.
2. To get your API Key and import our Postman Collection, go to the Developer’s Quick Start guide.
3. 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 various purposes, including expense reporting and accounting.
• SCIM API: This service was created to facilitate the management of people and groups of people. 
• Cost Objects API: This service enables the automatic management, creation, updating, and archiving of cost objects on the Perk 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 trip:

1. You’ll need to create a test payment profile. Go to Settings > Account > Payment profiles and click Create payment profile.
2. Enter the details of the test card from Stripe’s test card numbers.
3. Make sure you select the correct Company. Only people assigned to the selected Company will have access to the payment profile.
4. 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 the Organization tab.
5. To find the expense integrations, go to Settings > Integrations. On the integrations you want to test, click Start set up. 
6. Complete the setup process for the integration. For instructions, go to Expenses integrations.
7. Create a test trip.

Tip: 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.