API Introduction

How to use the API:

Api flow




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

"statusCode": 200,
"message": "POST Request successful.",
"isError": false,
"result": {}

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

statusCodeThe http status code
messageA message describing if the response was successful
isErrortrue/false to indicate if the request was successfully processed
resultThe response for your API call, in JSON
responseExceptionIn case the isError is true, the exception indicating the problem

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.

Run in Postman


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.