Quickstart for Developers
A quick introduction to building with Railz
Not a Developer?
This quickstart is specifically meant for developers. It will take you through the basic steps required to authenticate a connection and make your first API call as well as several basic requests. Not a developer? Check out our no-code Quickstart to get started with Railz.
If you get stuck at any point in the Quickstart, help is just a click away! Have a look at other sections of our documentation or reach out to our team through the Help Center.
Welcome to the Railz Docs, let’s get you building with Railz. The quickstart consists of 3 easy steps:
- Step 1: Authenticate - Make your first API call.
- Step 2: Create a Connection - Use Railz Connect™ to connect to your business users' financial data with the Railz API.
- Step 3: Making API Requests - Learn how to access and view your business customers' financial data.
Before you get started, you’ll need to generate API keys after you create a Railz account. You'll have two different API keys and there are two different Railz environments. Today we'll start in the Sandbox environment. View the API Keys section of the Dashboard in Sandbox mode to find your Sandbox client identifier and secret.
API Keys
identifier | Private API identifier for your account. |
secret | Private key, one for each of the two environments. |
️ Backup your API Keys
Note that when you generate new credentials, old credentials will no longer be valid. Make sure you backup your credentials for future use.
Environments
Environment | Description |
---|---|
Sandbox | Get started with a test integration and life-like data. |
Production | Launch your app with unlimited live connections. |
Production
Once you have completed your development and testing in the Sandbox, you can subscribe to a billing plan to activate your production environment and complete your integration process. This will allow you to connect to multiple real business connections and use the full Railz service.
Updated 12 months ago