How to use the API:
- All datetime fields are stored and returned as UTC format;
- All API requests must pass the header Content-type: application/json;
- API Return example
All API endpoints return the same response, containing 4 important pieces of information:
|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 json response for your API call|
|responseException||In case the isError is true, the exception indicating the problem|
For most uses-cases, our customers check if the response isError is true, if not, then checking the statusCode will help you identify the next step.
Follow these steps to quickly get started with the Zūm Rails API:
Once you have access to your sandbox portal:
Login in your sandbox portal, navigate to Settings -> Webhook & API Settings. Grab your api username and password
Download and install the Postman app
Install the Zūm Rails Postman Collection. Click the "Run in Postman" button below to install
In Postman find the endpoint /Authorize, paste your api username and password and it's all set.
This Postman Collection is already prepared to set the authorization token as an environment variable, so that you don't need to copy and paste the authorization token every time. If you need to change this configuration, go to Authorize endpoint in the Postman Collection, and open the Tests tab to view how this tweak is done.