The sandbox is a distinct environment that mimicks your production one. It gives you the ability to safely test out your API integrations before deploying them on your production environment.

The sandbox environment is an extra paying feature. Contact your sales rep if you want to be given access to it.

Setup

First, make sure you have access to the sandbox feature by going to “Gear icon” > Client Center > Sandbox.

Access

If you don’t, it is either not included in your subscription plan, or your access rights are insufficient. In the former case, contact your sales rep ; in the latter, contact your admins.

Create a sandbox

Create a sandbox, give it a name that will help you find it among the other ones. You may consider hiding sensitive data (e.g. employee’s personal data) if you do not need it.

Snapshot

It is created from a snapshot of your production data. You can mount a fresher snapshot through the “restore” feature.

Your authorized Client Applications are NOT duplicated on sandbox environments. You must re-declare them.

Note the URL

Make sure to note the sandbox URL, you will need to issue HTTP request to the Lucca API.

Delete once tests are over

Once your tests are over and you no longer need the sandbox, please make sure to delete it.

Learn more about managing sandboxes

Read our functional help page about how to manage sandbox environments.

Was this page helpful?