Server⠀

`POST /clients`

Endpoint requires credentials to be passed as Basic HTTP auth. Software Credentials must be known and it's not possible to retrieve them programmatically. Client shall register itself with first run. Client credentials can expire anytime - client has to register again. Scopes are only added to prevent conflicts between various SW versions.

CODE

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: []

Request body:
{
  "client_name": "string",
  "software_id": "string",
  "software_version": "string",
  "scope": "string"
}

Response body:
{
  "client_name": "string",
  "client_id": "string",
  "client_secret": "string",
  "scope": "string",
  "server_version": "string"
}

`GET /v3/server/status`

The response is and 1 or 0 , meaning the server is up and running or not and the configuration of the system needs to be checked.

Note: This endpoint does not need an authentication token.

CODE

Headers:
Content-Type: application/json

Authentication:
# No auth required

Response body:
1 or 0

`GET /v3/server/config`

JSON of basic configuration and enabled features of server are returned in the response.

CODE

Headers:
Content-Type: application/json

Authentication:
Grant_type: client_credentials
Scopes: []

Response body:
{
  "appName": "string",
  "type": "site",
  "license": {
    "specialEdition": "Education",
    "warning": "string"
  },
  "version": "string",
  "adminEmail": "string",
  "locale": {
    "lang": "string",
    "currency": "string",
    "currencyPrecision": 0
  }
}