Overview

All REST endpoints are automatically documented and made available through the OpenAPI/Swagger specification. The Swagger UI page provides an interactive environment for testing APIs and serves as comprehensive documentation for working with the endpoints. Each endpoint's request/response schema is automatically documented, making integration straightforward.

Testing Secure Endpoints

To test endpoints that require authentication:

1. Call the login endpoint to obtain an access token
2. Copy the access token from the response
3. Click the "Authorize" button at the top of the Swagger UI page
4. In the modal dialog, paste the token into the value field
5. Click "Authorize" to apply the token
6. You can now execute secure endpoints that require authentication on the Swagger UI page