Open API Explorer

The REST API includes an OpenAPI-compliant endpoint based on OpenAPI version 3.0.1 (formerly known as Swagger).

This endpoint provides a web-based interface that allows users to explore, test, and document the available API operations.

Endpoint

http://<server>:1581/explorer

Features

From this page, you can:

🧭 Test-drive the REST API directly through an interactive UI.
📄 View and download the raw OpenAPI document (JSON format).
⚙️ Integrate with external tools that consume OpenAPI specs.

Example Use Cases

Once you have the OpenAPI specification, you can use various tools to generate client libraries or SDKs.
For example, the Swagger Code Generator can produce SDKs in several languages, including:

C#
Java
JavaScript
Perl
Python

💡 Tip:
The OpenAPI document is fully compatible with most modern API development tools such as Postman, Insomnia, and Swagger UI, allowing you to automate testing and documentation effortlessly.