Метод управления лицензией

Для управления лицензией выполните запросы с помощью API-метода licenses (перед выполнением запроса определите токен администратора):

активация лицензии:

curl -v -X POST "<IP-адрес или DNS-имя сервера>/api/v2/licenses/" –header "accept: application/json" -H "Authorization: Bearer <токен администратора>" -F 'file=@<абсолютный путь до файла лицензии>/<наименование файла лицензии>.prm'

Пример ответа:

{
    "id": 3,
    "max_devices": 5,
    "max_users": 5,
    "max_devices_per_user": 5,
    "requests_per_minute": -1,
    "end_time": "2022-12-31",
    "system_id": "64329645253",
    "license_id": "e8e3647f-04a8-4696-920c-c72bb34a7ad8",
    "data_sources": null
}

получение информации о лицензиях:

curl -v '<IP-адрес или DNS-имя сервера>/api/v2/licenses/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

Пример ответа:

{
    "results": [
        {
            "id": 1,
            "max_devices": 5,
            "max_users": 5,
            "max_devices_per_user": 5,
            "requests_per_minute": -1,
            "end_time": "2022-12-31",
            "system_id": "64329645253",
            "license_id": "e8e3647f-04a8-4696-920c-c72bb34a7ad8",
            "data_sources": null
        },
        {
            "id": 2,
            "max_devices": 7,
            "max_users": 7,
            "max_devices_per_user": 7,
            "requests_per_minute": -1,
            "end_time": "2022-12-31",
            "system_id": "64329645253",
            "license_id": "be91a026-9edc-4782-a8d4-2653d8ac2a66",
            "data_sources": [
                "FAP_WEB",
                "POSTGRES"
            ]
        }
   ]
}

Значения параметров содержат следующую информацию о лицензии:

id. Идентификатор лицензии в списке существующих лицензий;
max_devices. Максимальное количество активных устройств;
max_users. Максимальное количество активных пользователей API;
max_devices_per_user. Максимальное количество устройств на пользователя;
requests_per_minute. Максимальное количество запросов в минуту. Если параметр принимает значение «-1», то ограничение на количество запросов не установлено;
end_time. Срок действия лицензии;
system_id. Идентификатор инсталляции;
license_id. Уникальный идентификатор лицензии;
data_sources. Доступные источники данных. Если параметр принимает значение «null», то доступны все источники данных;

изменение настроек оповещения о превышении ограничений, заданных в лицензии:

curl -X POST -v '<IP-адрес или DNS-имя сервера>/api/v2/licenses/notifications-settings/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>' -d '{
    "use_email": <метод оповещения (0-в логи или 1-по e-mail и в логи)>,
    "days_before": <остаток времени действия в днях>,
    "period": <периодичность повтора в днях>,
    "device_rate": <остаток устройств в процентах>,
    "user_rate": <остаток пользователей в процентах>
}'

Пример ответа:

{
    "use_email": 1,
    "days_before": 2,
    "period": 3,
    "device_rate": 15,
    "user_rate": 15,
    "last_run_at": null,
    "license_error_status": "{}"
}

получение настроек оповещения о превышении ограничений, заданных в лицензии:

curl -v '<IP-адрес или DNS-имя сервера>/api/v2/licenses/notifications-settings/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

Пример ответа:

{
    "use_email": 0,
    "days_before": 5,
    "period": 5,
    "device_rate": 10,
    "user_rate": 10,
    "last_run_at": null,
    "license_error_status": "{}"
}

удаление лицензии:

curl -X DELETE -v '<IP-адрес или DNS-имя сервера>/api/v2/licenses/<идентификатор запрашиваемой лицензии>/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

В подстановке <идентификатор запрашиваемой лицензии> используйте значение параметра id, которое возвращается при получении информации о лицензиях.

Пример ответа:

204

См. также:

API сервера