You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

Профиль позволяет просматривать личные данные пользователя, изменять настройки, видеть текущий баланс вендора.

Изменение личных данных доступно только для пользователя с ролью "Администратор".

Получение информации о пользователе

Авторизация требуется. Входных параметров нет. 

GET /v1.0/profile

Возвращает элемент user: 

{
  "user": {
    "_id": 10015,
   "companyname": "Aktiv",
   "confirmed": true,
   "countryid": 185,
   "email": "test@example.com",
   "phone": "12345",
   "status": true,
   "userdetails": {
     "_id": 10016,
    "firstname": "Mikhail",
    "lastname": "Bakalyarov",
    "lastvisitdate": 1529418565,
    "role": {
      "_id": 1,
      "createorders": true,
     "createproducts": true,
     "createusers": true,
     "manageprotect": true,
     "nameeng": "Administrator",
     "namerus": "Администратор"
    },
   "settings": {
    "language": 0
}}}}

Получение кодов доступа 

Авторизация требуется. Входных параметров нет. 

Коды доступа ассоциированы с вендором, поэтому одинаковы для всех пользователей одного вендора.

Массив 'private' возвращается только для пользователей с ролью 'Администратор' или 'Разработчик'.

GET /v1.0/profile/accesscodes

Возвращает массив accesscodes: 

{
"accesscodes": [
{
  "_id": 1,
  "private": {
  "mastervalue": "0x5191758c",
  "readvalue": "0x51917645",
  "writevalue": "0x51917603"
},
  "public": {
  "text": "DEMONVK",
  "value": "0x519175b7"
}
},
{
  "_id": 9,
  "private": {
  "mastervalue": "0xe1e1e1e",
  "readvalue": "0xd2d2d2d2",
  "writevalue": "0xd2e2e2e2"
},
  "public": {
  "text": "EXAMPLE",
  "value": "0xb3b3b3b3"
}}]}

Изменение профиля (только для администратора)

Авторизация требуется.  Входные параметры RAW JSON:

{
  "companyName": "Aktiv",
  "countryId": 185,
  "phone": "12345",
  "firstName": "Mikhail",
  "lastName": "Bakalyarov"
}

PUT /v1.0/profile

Получение информации о балансе (только для администратора) – СТАРЫЙ ЗАПРОС

Авторизация требуется. Входных параметров нет. 

GET /v1.0/profile/balance

Возвращает элемент balance: 

{
  "balance": {
  "_id": 10016,
  "activationscount": -842150451,
  "activationslimit": -842150451,
  "companyname": "Aktiv",
  "countryid": 185,
  "ispostpaid": true,
  "locallicensesbalance": -842150451,
  "netlicensesbalance": -842150451,
  "phone": "12345",
  "status": -12851,
  "subscriptionbegindate": 0,
  "subscriptionenddate": 0
}}

Получение информации о балансе (только для администратора) – НОВЫЙ ЗАПРОС

Авторизация требуется. Входных параметров нет. 

GET /v1.0/profile/extendedbalance

Возвращает элемент объект balance. В зависимости от поля "isstandalone" набор остальных полей будет разный. 

Для поля isstandalone со значением false:

{
    "balance": {
        "_id": 13,
        "amountOfNotActivatedSerials": 167,
        "restActivationsOfSerials": 456,
        "amountOfNotActivatedSerialsForTrials": 44,
        "restActivationsOfSerialsForTrials": 14,
        "activationscount": 70,
        "activationslimit": 1000,
        "companyname": "Aktiv Co.",
        "countryid": 185,
        "donglenetlicensesbalance": 0,
        "donglenetlicensessubscription": 0,
        "isstandalone": false,
        "licensingmodelfordonglenetlicenses": 0,
        "licensingmodelforlocallicenses": 0,
        "licensingmodelfornetlicenses": 0,
        "licensingmodelfortriallicenses": 0,
        "locallicensesbalance": 971,
        "locallicensessubscription": 0,
        "netlicensesbalance": 1793,
        "netlicensessubscription": 0,
        "phone": "79031260298",
        "reactivationgraceperiodenddate": 1789737240,
        "subscriptionenddate": 1663506840,
        "triallicensesbalance": 0,
        "triallicensessubscription": 0
    }
}

Для поля isstandalone со значением true:

{
    "balance": {
        "_id": 13,
        "amountOfNotActivatedSerials": 167,
        "restActivationsOfSerials": 456,
        "companyname": "Aktiv Co.",
        "countryid": 185,
        "donglenetlicensesbalance": 50,
        "donglenetlicensessubscription": 1646380088,
        "isstandalone": true,
        "licensingmodelfordonglenetlicenses": 2,
        "licensingmodelforlocallicenses": 2,
        "licensingmodelfornetlicenses": 2,
        "licensingmodelfortriallicenses": 0,
        "locallicensesbalance": 20,
        "locallicensessubscription": 1646212157,
        "netlicensesbalance": 50,
        "netlicensessubscription": 1646380088,
        "phone": "79031260298",
        "triallicensesbalance": 0,
        "triallicensessubscription": 0
    }
}

Получение журнала аудита

Авторизация требуется. Работает только для пользователя с ролью 'Администратор'.

GET /v1.0/auditlog

Опциональные параметры запроса:

  • sortby - сортировка элементов журнала. Возможные значения: date - сортировка по дате действия. По умолчанию, если параметр не указан, выполняется сортировка по дате;
  • direction - направление сортировки. Возможные значения: asc - сортировка от меньшего к большему, desc - сортировка от большего к меньшему;
  • limit - максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100;
  • offset - смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
  • from - фильтр по дате действия в логе. В результат запроса будут попадать действия, у которых дата будет больше, чем дата, указанная в этом параметре (в формате unix time);
  • to - фильтр по дате выполнения действия. В результат запроса будут попадать действия, у которых дата будет меньше, чем дата, указанная в этом параметре (в формате unix time);
  • users - список ID пользователей через запятую, чьи действия попадут в результат запроса;
  • events - список ID действий через запятую, которые попадут в результат запроса.

Возвращает массив auditlog, каждый JSON-объект которого включает в себя информацию о действии и пользователе, который его совершил.

Пример результата запроса:

{
    "auditlog": [
        {
            "_id": 31,
            "eventdate": 1730369403,
            "eventtype": 1,
            "ip": "127.0.0.1",
            "user": {
                "_id": 18,
                "confirmed": true,
                "email": "msgtome@bk.ru",
                "status": true,
                "userdetails": {
                    "_id": 18,
                    "archivationdate": 0,
                    "archived": false,
                    "firstname": "Сергей",
                    "lastname": "Петров",
                    "lastvisitdate": 1730369403,
                    "role": {
                        "_id": 1,
                        "createorders": true,
                        "createproducts": true,
                        "createusers": true,
                        "manageprotect": true,
                        "nameeng": "Administrator",
                        "namerus": "Администратор",
                        "readvendorbalance": true
                    }
                }
            }
        },
        {
            "_id": 30,
            "eventdate": 1730369389,
            "eventtype": 2,
            "ip": "127.0.0.1",
            "user": {
                "_id": 18,
                "confirmed": true,
                "email": "msgtome@bk.ru",
                "status": true,
                "userdetails": {
                    "_id": 18,
                    "archivationdate": 0,
                    "archived": false,
                    "firstname": "Сергей",
                    "lastname": "Петров",
                    "lastvisitdate": 1730369403,
                    "role": {
                        "_id": 1,
                        "createorders": true,
                        "createproducts": true,
                        "createusers": true,
                        "manageprotect": true,
                        "nameeng": "Administrator",
                        "namerus": "Администратор",
                        "readvendorbalance": true
                    }
                }
            }
        }
    ]
}

Возможные значения ID событий (параметр events):

1 - выполнен вход,
2 - выполнен выход,
3 - восстановлен пароль,
4 - изменен пароль,
5 - создан продукт,
6 - изменен продукт,
7 - заархивирован продукт,
8 - разархивирован продукт,
9 - создан компонент,
10 - изменен компонент,
11 - заархивирован компонент,
12 - разархивирован компонент,
13 - создан покупатель,
14 - изменен покупатель,
15 - заархивирован покупатель,
16 - разархивирован покупатель,
17 - создан пользователь,
18 - изменен пользователь,
19 - заархивирован пользователь,
20 - разархивирован пользователь,
21 - заблокирован пользователь,
22 - разблокирован пользователь,
23 - создана ячейка памяти,
24 - изменена ячейка памяти,
25 - заархивирована ячейка памяти,
26 - разархивирована ячейка памяти,
27 - подтвержден первичный заказ,
28 - аннулирован первичный заказ,
29 - подтвержден заказ
30 - аннулирован заказ
31 - увеличено число доступных активаций серийного номера,
32 - заблокирован серийный номер,
33 - разблокирован серийный номер,
34 - аппаратный ключ добавлен в заказ (перед первичной прошивкой из фронта).

  • No labels