API Docs

2025-04-12T06:15:10.190208546

General notes

All requests below should be executed as HTTP POST to /web/service endpoint

All requests with roles containing all can be executed without authorization header. For all other requests, user needs to be authenticated. In order to authenticate use should login or register and obtain a JWT token to be used in subsequent requests.

Account creation

Account creation consists of two steps: account creation and account activation. User account is created on the server by performing a signup request. Account is disabled by default and needs to be activated with activation code. Activation code on the frontend is represented as captcha image which is generated on the server during account creation. Captcha can be shown with the following snippet:
<img src="/web/service/captcha" width="400" height="200">
Activation code needs to be sent to the server with the request activate in system service.

Error handling

Errors from backend are propagated to the frontend via ErrorResult model which has two fields:

errorCode
Contains the code of the error
errorMessage
Contains non-localized error message.
Frontend should check the response type and perform functionality based on errorCode or errorMessage.

Services & Requests

Types