API Introduction

How to use the API:

Environments

Production:

• Live Portal: https://app.zumrails.com
• Live API base URL: https://api-app.zumrails.com

Sandbox:

• Sandbox Portal: https://sandbox.zumrails.com
• Sandbox API base URL: https://api-sandbox.zumrails.com

API Specifics

• All datetime fields are stored and returned as UTC format;
• All API requests must pass the header Content-type: application/json;

API Structure

Example API Response

{

"statusCode": 200,

"message": "POST Request successful.",

"isError": false,

"result": {}

}

All API endpoints return the same response, containing 4 important pieces of information:

Field	Description
statusCode	The http status code
message	A message describing if the response was successful
isError	true/false to indicate if the request was successfully processed
result	The response for your API call, in JSON
responseException	In case the isError is true, the exception indicating the problem

info

For most use-cases, our customers check if the response isError is true. If not, then checking the statusCode will help you identify the next step.

Postman Collection

Follow these steps to quickly get started with the Zūm Rails API:

Once you have access to your sandbox portal:

1. Login in your sandbox portal, navigate to Settings > Webhook & API Settings. Grab your API username and password.

2. Download and install the Postman app.

3. Install the Zūm Rails Postman Collection. Click the "Run in Postman" button below to install.

4. In Postman find the endpoint /Authorize, paste your API username and password, and it's all set.

note

This Postman Collection is already prepared to set the authorization token as an environment variable, so you don't have to copy and paste the authorization token every time. If you need to change this configuration, go to Authorize endpoint in the Postman Collection, open the Tests tab and update the test script.