Test in Sandbox
Sandbox API Keys & Widget ID Format
The sandbox and production environments function almost identically, with a few necessary differences. Your sandbox API keys and Railz Connect™
widgetIdwill haveSB_PRODas a prefix. (e.g.SB_PROD_00000CA111B222F33FC4444DF3CE67B0)
Testing Railz Connect in Sandbox
In the Sandbox, you can test Railz Connect without needing to authenticate a real connection. This makes it easy to integrate Railz Connect into your application and test the end-user connection experience. You'll need the sandbox Railz Connect widgetId, which you can find in the Railz Dashboard™. For more details on how to use connect a business using Railz Connect, see Railz Connect.
Testing Railz API in Sandbox
In the Sandbox, you can test the Railz API using your Sandbox API Keys. You can find the Sandbox API keys in the Railz Dashboard™. When making API calls in the sandbox, you can use the same serviceName values used in production. For more details on how to use the Railz API, see our API reference.
Supported Integrations & Data in Sandbox
You can access sample data from all integrations supported by Railz in Sandbox. See Supported Integrations for more details.
Pushing Data on Railz Mocked Sandbox
Pushing data on the sandbox is done through mocked responses. No actual data is being created in the Sandbox. Accordingly, pulling data on Sandbox will not contain any records you previously pushed.
Attachments on Railz Mocked Sandbox
Pulling and posting attachments are currently not supported in the current version of the Railz mocked sandbox.
Simulating Webhook Events
The Sandbox provides rich test data, as well as the ability to simulate a number of scenarios for testing in Sandbox. Railz provides a special Sandbox-only endpoint, /sandbox/fireWebhooks, that can be used to trigger webhooks events on-demand, allowing you to test that you are receiving webhooks successfully for both Railz Mocked Sandbox and Accounting Service Provider Sandbox. See Webhooks for more details.
Sandbox Test Credentials
Simulate different flows using Sandbox credentials. The easiest approach to create connections in the Sandbox is by using the following usernames and password pass_good to simulate the test scenarios that your SMBs may experience while connecting their businesses.
| Test Scenario | Use Case |
|---|---|
| Successful Connection | Credentials are entered correctly to successfully access data for your business connection. |
| Duplicate Connection | Simulate a duplicate connection attempt to trigger the system's response to handle and return the appropriate duplicate entry response. |
| Failed Connection | A connection error can occur due to various reasons, including network issues, server unavailability, or issues with the application's configuration. The business connection will not be established. |
| Invalid Credentials | Mimics entering the wrong credentials and returns an error. |
| No Data | Credentials are entered successfully but the business will return no data. |
Help Us Improve Our Sandbox
Our team is working on adding more test credentials to test other flows. If there are events or scenario you you would like to simulate on Sandbox please suggest or upvote it on our Product Roadmap.
Updated 5 months ago