How to use the API:
- All datetime fields are stored and returned as UTC format;
- All API requests must pass the header
- Example API Response
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 response for your API call, in JSON|
|responseException||In case the isError is true, the exception indicating the problem|
For most use-cases, our customers check if the response
true. If not, then checking the
statusCode will help you identify the next
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 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.