📖 Table of contents
Discover the Sandbox environment
Yousign API offers two environments:
Sandbox - Environment for exploration within the Yousign API.
Production - Environment for your live API integration.
These environments are completely separate. The Sandbox environment lets developers safely experiment with code and features without impacting the live Production environment.
Signature requests created in the Sandbox environment are for testing purposes only. They are not legally binding.
To learn more about the sandbox environment, consult our API documentation.
You can access some Sandbox resources directly from the Yousign application.
How to activate the “Sandbox mode” in your application?
Prerequisites
In order to access your Sandbox resources, you must:
Be an Owner or Admin. Members can’t access the sandbox mode.
Have at least one sandbox API key created in your Organization. Consult this article to learn more.
To enable Sandbox mode:
In the left-hand menu of the app, toggle the Sandbox mode switch.
The app will now be in Sandbox mode.
Once activated, you’ll be able to explore in “Sandbox mode” the available Sandbox resources in the app.
Please note: The Sandbox environment in the app currently offers limited features compared to Production.
Limitations of the in-app Sandbox environment:
Application Page | Availability |
Templates | ✅ Available |
Contacts | ✅ Available |
API > Webhooks | ✅ Available |
Signature Requests | 🟡 Partially available:
|
Inbox | ❌ Not available |
Documents | ❌ Not available |
Integrations | ❌ Not available |
API > API keys | ❌ Not available |
API > iFraming | ❌ Not available |
API > Logs | ❌ Not available |
Billing | ❌ Not available |
Settings | ❌ Not available |
Troubleshoot error: I am an Admin user and I can’t access the Sandbox mode
If this is your case, you will see this error message appear on the screen when you try to activate the Sandbox mode.
This means that your application user does not have access to any of your organization’s workspaces in the Sandbox environment.
You can solve the problem by adding your user to one or multiple sandbox workspaces. As of now, it’s only possible to do it via the API:
Retrieve your user ID by calling the List Users endpoint
In the sandbox environment, retrieve the ID(s) of the workspace(s) you want to grant the user access to by calling the List Workspaces endpoint.
In the sandbox environment, add your user ID to a workspace by calling the Associate a user to a workspace endpoint.
Once your user has access to a sandbox workspace, you should be able to access the Sandbox mode in the application.