Skip to content

REST API

The application provides comprehensive API documentation to facilitate ease of use and integration. API documentation is available via two main interfaces:

Swagger UI

An interactive interface that allows users to explore and test the API endpoints. It provides detailed information about the available endpoints, their parameters, and response formats. Users can input data and execute requests directly from the interface.

URL: http://localhost:8000/api/rest/swagger/

Redoc

A static, beautifully rendered documentation interface that offers a more structured and user-friendly presentation of the API. It includes comprehensive details about each endpoint, including descriptions, parameters, and example requests and responses.

URL: http://localhost:8000/api/rest/redoc/

These interfaces ensure that developers have all the necessary information to effectively utilize the API, enabling seamless integration and interaction with the application’s features.

Environment-Specific URLs

The URLs will vary depending on the server where it is hosted. If the server is hosted elsewhere except for the local machine, replace http://localhost:8000 with the server's domain URL.