Environments

Yousign API offers two environments:

• Sandbox environment for explorations within Yousign API.
• Production environment for your live Signature Requests and Electronic Seals.

These two environments are isolated, and allow developers to experiment with new code and features on Sandbox without affecting the live Production environment.

When you create your API Key, you can specify which environment you want to use.

Sandbox

The Sandbox environment is the only environment available during the free API trial period. Once you move to an active subscription, you can keep carrying out tests in the Sandbox environment.
When subscription expires and is not renewed, you lose access to the Sandbox.

There are some limitations to be aware of in your development phase.

Functional limitations

• Signatures and Electronic Seals are not legally binding. A visual Signature is indeed placed at each Signature Field position but the legal Signature is not present. Same rule applies for Audit Trails.
• All Documents included in a Signature Request and Electronic Seals are watermarked, including Audit Trails.
• For security reasons, some specific features and parameters are not available during the free trial API period. They will be available in Sandbox after an API subscription has been purchased.

Technical limitations

The Sandbox environment is available for manual testings, explorations, and for your development steps.

A Rate Limit is applied to ensure normal activity: 30 queries/minute and 200 queries/hour. Please find more information about Rate Limits in the dedicated page.

📘

Some usages are strongly discouraged / not supported

• E2E tests, functional tests, or any others automatic tests. If you want to create E2E tests that include Yousign API, you need to mock calls and responses.
• Batch queries issuing a lot of calls in small periods of time.
• Load testing: if you want to carry test on Yousign API with production-like volume, please reach out to the customer support team.

Sandbox ressources in Yousign application

You can interact with Sandbox ressources in Yousign Application, by switching the toggle named "Sandbox mode".
You can see this switch toggle in pages Signature requests, Trash, and Templates.
Please note that Sandbox ressources can only be viewed in application. No write action is authorized for the moment.

Production

The Production environment is the live environment where Users interact with the actual API.

If you are done with the Sandbox and want to go to Production, please contact the sales team. You can find an overview of pricing and packages.

Understanding resources sharing and isolation between environments

Yousign Data Model is composed of 3 Domains: Common, Production, and Sandbox.

Each Resource is scoped to a shared Domain (Common) or isolated Domain (Sandbox / Production). Here is the detail:

Ressources that are present in the Common Domain have a limited access when using the Sandbox environment.

📘

Difference between data generated in shared or isolated Domain

• Data generated in Production and Sandbox environment are strictly isolated from each other
• Data generated in Common Domain are shared for Production and Sandbox environments

Example with Webhooks (Common) in Sandbox mode

• If you are in trial API period, you only have access to the Sandbox environment. During this time, you cannot create Webhooks subscriptions with Sandbox API Key. You need to create it from the application. See dedicated Guide.
• Once you have access to the Production environment, with your Production API Key you are able to create a Webhook Subscription for both environments by using the boolean param sandbox set to true for Sandbox, or false for Production.