Developer Tools
Sandbox
Evervault's Sandboxes provide isolated environments for testing and validating configurations without affecting app. Unlike regular apps, they grant access to all Enterprise Features, enabling advanced testing. Sandboxes include specialized tools like simulating card updates and triggering webhook events to refine integrations before going live. This ensures development and app stay separate, protecting app data while fully utilizing Evervault's features for comprehensive testing.
Sandbox vs App
Sandbox | App |
---|---|
Designed for testing, experimentation, and validation in a safe environment. Ideal for testing new features and integrations and evaluating Enterprise Features (e.g. 3D-Secure, Card Account Updater, etc.). | Used for live business operations, handling real user data, and ensuring the reliability and performance of your services. |
Data and metrics are isolated from app, ensuring that test results do not affect live data or operations. | Handles real-world data with no cross-contamination from test environments, ensuring accurate analytics and reporting. |
Full range of Evervault features, including Enterprise Features, are available for thorough testing and evaluation. | Evervault primitives and any Enterprise features that have been enabled on your account. |
Minimizes risk by isolating errors, bugs, and issues within the sandbox environment, preventing them from affecting app. | Focuses on minimizing downtime and ensuring that changes are thoroughly tested before deployment to maintain high reliability. |
Creating a Sandbox
Access the App Switcher: Begin by navigating to the App Switcher within your Evervault dashboard.
Select
+ New App
: Click on the New App option. This will prompt a modal to appear, as shown in the image below.Enable Sandbox Mode: Within the modal, you'll find a checkbox labeled Sandbox. Check this box to ensure the app you're creating will function as a Sandbox.
Name Your App: Provide a name for your Sandbox. We recommend using a naming convention that aligns with your apps. For example, if your App is named "Production", you might name your sandbox environment Staging Sandbox.
Create the App: Once you've named your app and confirmed that Sandbox mode is enabled, click the Create App button. Your new Sandbox will be created instantly, ready for you to begin testing.
Sandbox status is immutable, meaning that if you create a Sandbox, it cannot be converted to an App later.
Identifying Sandboxs
Sandboxes are easily identifiable within the App Switcher, marked with a sandbox
pill.
Best Practices for Using Sandboxes
Sandboxes retain the full suite of functionalities available in a production environment. This feature-rich setup allows you to replicate your production environment precisely, enabling thorough testing and validation. However, to maximize the benefits of using Sandboxes, consider the following best practices:
Segregate Testing and Production Data: Always use Sandbox to test changes, ensuring that your production configuration and data remain untouched. This segregation prevents any accidental data corruption or configuration issues in your live environment.
Test with Confidence: Utilize the sandbox environment to test any changes or updates thoroughly. By doing so, you can confidently apply these changes to your production environment, knowing they've been vetted in an isolated environment.
Mirror Production Configurations: When creating a Sandbox, mirror your production environment as closely as possible. This practice ensures that the testing outcomes are reliable and applicable to your live environment.
Naming Conventions: Use consistent naming conventions to clearly differentiate between your sandbox and production environments. This practice aids in avoiding confusion when switching between apps.
Replicate and Deploy: After testing and validating your configurations in your Sandbox, replicate the settings to your App. This approach minimizes downtime and ensures a smooth transition from testing to app.
By following the outlined practices and leveraging Sandboxes effectively, you can ensure a smooth, risk-free development process while maintaining the integrity of your app environment. As Evervault continues to evolve, Sandboxes will remain a cornerstone for testing and evaluating new features, giving you the confidence to innovate without hesitation.
See the following related articles for details on how to leverage Sandboxes to test your Card Account Updater or Network Token webhook integration.
Simulate Card Account Update
Learn how to simulate a Card Account Update to test your Card Account Updater integration
Get StartedSimulate Network Token Update
Learn how to simulate a Card Account Update to test your Card Account Updater integration
Get Started