Overview

A quick introduction to building with Railz

📘

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 Railz Sites for a no-code way to get started with Railz.

Welcome to the Railz Docs, let’s get you building with Railz. The quickstart consists of 3 easy steps:

Before you get started, you’ll need API keys, which you can receive by signing up in the Dashboard.

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.

You can enable the Sandbox mode by toggling the Dashboard’s Enable sandbox option in the side navbar.

Railz Dashboard - Enable Sandbox. Click to Expand.Railz Dashboard - Enable Sandbox. Click to Expand.

Railz Dashboard - Enable Sandbox. Click to Expand.

API Keys

identifier Private API identifier for your account.
idensecrtifier Private key, one for each of the two environments.

🚧

API keys can only be viewed and copied by users with Administrator or Developer roles. See detailed team permissions for more details.

❗️

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

Sandbox Get started with a test integration and life-like data.
Production Launch your app with unlimited live connections.

📘

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.


Read Next

Let's get started! 🚀

Did this page help you?