Sandbox Overview

The Railz sandbox is a free and fully-featured environment for application development and testing. All Railz functionality of both the Railz API and Railz Connect™ is supported in the Sandbox environment. A variety of accounting data is available to test against, and you can create an unlimited number of test businesses and connections. Sandbox API keys can be obtained in the Railz Dashboard™.

Railz Cloud Accounting is our dummy accounting service provider for you to test happy paths and edge cases while experimenting with different functionalities. While we have tried to make this data as varied as possible, please bear in mind it is mostly generated by our team and we cannot guarantee its completeness or accuracy.

❗️

For security and privacy reasons, you are not able to make live connections to real accounting service providers in this environment.

Using Sandbox

The Sandbox can be accessed via the Railz Dashboard™. You can enable the Sandbox mode by toggling the Dashboard’s Enable sandbox option. No credentials are required for accessing Railz Cloud Accounting on the sandbox.

🚧

Environment API Keys

The sandbox and production environments function almost identically, with a few necessary differences. Your sandbox API keys and Railz Connect™ widgetId will have SB_PROD as a prefix. (e.g. SB_PROD_00000CA111B222F33FC4444DF3CE67B0)

Linking to Sandbox

  1. Initiate Railz Connect in your client-side application. See Railz Connect™ for more details.
  2. Once Railz Connect™ loads, you should see the following screen:
Railz Connect - Sandbox View. Click to Expand.Railz Connect - Sandbox View. Click to Expand.

Railz Connect - Sandbox View. Click to Expand.

  1. Select Sandbox and click on Continue. No credentials are required for accessing the API.
  2. Once your business is linked through the Sandbox, it can be treated like any other linked business, i.e. the data can be viewed through either the Railz Dashboard™ or the Railz API as normal.

📘

No authorization credentials are required for accessing the Railz Cloud Accounting service.

Sandbox Data

The Sandbox provides rich test data as of March 2020. We add data on a need-to basis to ensure coverage for all use cases.

📘

Need more Sandbox data?

If you need to simulate specific accounting data or transactions, please reach out to our product team through the Help Center.

Pushing Data

Pushing data is available on the Sandbox using the Railz Cloud Accounting service. See Pushing Data for more details.

🚧

To access Sandbox data using the API, your API calls should use sandbox as serviceName.


What’s Next
Did this page help you?