Integrating Big Data Platforms with Zaloni: REST API

In conversations about Zaloni Arena DataOps platform, the most common question we hear is “Can it integrate with product X?” which is almost immediately followed by “Can I use it without the UI?”. The answer to both is “Yes.” And it’s all made possible by the robust REST API that is built into our Platform.

This image displays an example of the interactive API documentation that is built on Swagger. Although classic documentation formats are available via PDF, you’ll want to check this out. The interactive documentation expedites the learning curve for making basic calls and crafting the correct input syntax for the API you are trying to use.

Understanding API Calls Through the Command Line

For example, you may want to understand variables in the Platform Namespace. Much like environmental variables in a Linux shell, Zaloni has a Namespace used to pass variables to different parts of the product. The command line below is a great example of what this will look like.

“page”: null
}

For project ID 9 (aka Trouble Tickets in this system) there are two known workflows with IDs 59 and 62.

Practicing API Calls with the Swagger UI

Most users need some assistance when using a new API. It’s really helpful to have a way to practice iterating over the creation of a correct call before putting it into your process. In the interactive Swagger documentation, that same call would look something like the diagram below:

Under the workflow page we navigate to the search API and then fill in the correct values. In this case passing just a project ID is enough. This corresponds to the concept of projects in Zaloni Arena. These can be listed out via the “Administration” menu under “projects” or via another API call to obtain all project IDs.