Используется для регистрации нового пользователя в системе.

Регистрирует пользователя с указанным email (параметр user_provider_id) и создает новую компанию, в которой пользователь становится администратором (роль Admin).

На указанный email отправляется ссылка для подтвержения аккаунта.

Пользователь сразу логинится в системе (создается сессия) и может выполнять любые запросы, требующие авторизации.

Параметры:

userProviderId - email пользователя (обязательный) 
type - тип регистрации, всегда "EMAIL" (обязательный)
password - пароль (обязательный)
name - имя нового пользователя (необязательный, по умолчанию копируется email)
phone - телефон нового пользователя
company_name - название компании (необязательный, по умолчанию будет имя из email до символа @
timezone - (обязательный) значение часового пояса из справочника dictionary (см. type = 'timezone')
language - (обязательный) значение из справочника dictionary (см type = 'lang')
captcha - код с картинки получаемой методом GET /captcha
invite_id - ID приглашения, получается из link в письме на почту, параметр invite_id
{
  "userProviderId": "mihsh1111@tut.by",
  "type": "EMAIL",
  "company_name": "BigBin",
  "password": "11111", 
  "name": "Имя пользователя",
  "timezone": {
    "key": "UTC+3"
  },
  "language": {
    "key": "ru"
  }
}

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

Код 200 и пустой body в случае успеха.

Если уже есть аккаунт (см. /approve) с таким email, то возращается Код 422 и body c ошибкой session.errors.emailAlreadyRegistered

В случае частого вызова метода (чаще чем раз в 30 секунд), то возращается Код 400 и body validation.errors.often

Авторизация пользователя с помощью email

Проверяет корректность связки email и пароля для авторизации пользователя. Если авторизация проходит успешно, то в cookies помещается id сессии пользователя, которая используется для авторизации дальнейших вызовов функции API под авторизованным пользователем. В случае если пользователь заходит по временному паролю (присланному при восстановлении пароля или вторичной регистрации по уже зарегистрированному телефону), то временный пароль становится постоянным.

Параметры:

"userProviderId" - email (обязательный) или логин
"provider_key" - костанта "TEXT" (обязательный)
"password" - пароль (обязательный)

"is_admin_panel" - true отправляется при входе в админ-панель

В поле password необходимо указать пароль, полученный при регистрации по смс (или email при тестовом режиме)

{
  "userProviderId": "test1@ya.ru",  (обязательный)
  "provider_key": "EMAIL",  (обязательный)
  "password": "33100078"        (обязательный)
}

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

В случае успешной авторизации возвращается пустой body с кодом 200.

В случае не успешной авторизации возвращается status: 422 и json-body с ошибкой.

Восстановление пароля

Метод создает временный пароль для существующего пользователя. Новый пароль отправляется на указанный email. В тестовой среде отправляет письмо на отладочные почтовые ящики.

Параметры:

user_provider_id - телефон пользователя (обязательный)
type - константа, всегда "EMAIL" (обязательный)
{
  "user_provider_id": "test1@ya.ru", 
  "type": "EMAIL" 
}

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

Код 200. Даже если пользователь с указанным паролем не существует.

{
  "pssword": ""
}

Ошибка валидации - код 422, с перечнем ошибок в полях

{
    "errors": [
        {
            "code": 4221,
            "field": "password",
            "message": "Отсутствует параметр"
        }
    ],
    "code": 4220,  //общий код ошибки 
    "message": "Отсутствует параметр" // частный 
}

Вход через qr

Метод создает временный пароль для существующего пользователя. По ссылке auth.recovery_url можно получить сессию и сменить пароль. Так же, если для пользователя настроен vpn, его парамеры будут возвращены в теге vpn

Параметры:

user_id - id пользователя (обязательный)

Роль: Супервизор и выше.

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

Код 200. Даже если пользователь с указанным паролем не существует. Ответ всегда такого вида

{
    "vpn": {
        "privateKey": "ULVS+24iL5KGaQuDOWwx97MrMdWiyb8OPbic5uaz6kk=",
        "address": "10.8.0.4/23",
        "dns": "8.8.8.8",
        "publicKey": "kD4mmtvAAcSQo1A4jFGVrXfSS6ANk9dqpcs3NJ5c904=",
        "allowedIPs": "0.0.0.0/0",
        "endpoint": "37.151.94.172:51820",
        "persistentKeepalive": "20"
    },
    "auth": {
        "recovery_url": "https://dev5.skif.pro/recovery/75c93998-f410-4e4a-a470-722940f10946"
    }
}

Ошибка валидации - код 422, с перечнем ошибок в полях

{
    "errors": [
        {
            "code": 4221,
            "field": "",
            "message": "Отсутствует параметр"
        }
    ],
    "code": 4220,  //общий код ошибки 
    "message": "Отсутствует параметр" // частный 
}

Выход из учетной записи

Удаляет все сессии пользователя на сервере.

Параметры: пусто

Ответ: 200

Сбросить пароль пользователя администратором (только администратор)

Установить новый временный пароль для пользователя. После чего пользователь должен изменить пароль после входа.

Параметры:

user_id - ID пользователя
newPassword - новый пароль

Роль: Администратор и выше.

Ответ: Пустой 200. Новый пароль установлен или ошибка

Пример запроса:

{
    "newPassword": "12345678"
}

Изменить свой пароль пользователем

Установить новый пароль пользователя для себя.

Параметры:

password - текущий пароль
newPassword - новый пароль

Ответ: Пустой 200 новый пароль установлен или ошибка

Пример запроса:

{
    "password": "123456",
    "newPassword": "12345678"
}

Подтверждение email. Используется для подтверждения email по ссылке полученной на почту.

Делает email подтвержденным, после чего зарегистироваться с таким email уже не возможно.
Пользователь сразу авторизуется в системе без ввода email и пароля.

Создается временный id помещенный в redis со временем жизни 30 мин

Параметры:

id - временный id связанный с email

Ответ:

Возвращает код 200 с пустым body

Возвращает код 422 в случае если id не валидно

{
    "code": 4022,
    "field": "id",
    "message": "Ссылка устарела, повторите операцию"
}

Авторизация по приглашению. Используется для получения доступа к компании по ссылке, полученной на почте.

Создает пользователя, если он не был ранее зарегистрирован и дает доступ к компании из которой Администратор вызвал метод POST /invite
Пользователь сразу авторизуется в системе без ввода email и пароля под приглашенной Компанией.

Пример запроса:

Создается временный id помещенный в redis со временем жизни 30 мин.

id связан с email и компанией, в которую приглашают пользователя (оба значения можно помещать в качестве значения в redis)

Параметры:

id - временный id связанный с email и Компанией в которую приглашают пользователя

Ответ:

Возвращает код 200 с пустым body

Возвращает код 422 в случае если id не валидно

{
    "code": 4022,
    "field": "id",
    "message": "Ссылка устарела, повторите операцию"
}

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

Пользователь сразу авторизуется в системе без ввода email и пароля. При этом если у пользователя доступ к нескольким компаниям, то предлагается выбор Компании, в которую пользователь хочет войти через метод GET switchcompany/:id

Пример запроса:

Создается временный id, помещенный в redis со временем жизни 30 мин. id связан с email

Параметры:

id - временный id связанный с email

Ответ:

Возвращает код 200 с пустым body

Возвращает код 422 в случае, если id не валидно

{
    "code": 4022,
    "field": "id",
    "message": "Ссылка устарела, повторите операцию"
}

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

Запрос получения кода

Параметры:
provider_key: text, для подтверждения номером телефона (пока только так) provider_key = PHONE
userProviderId - text, номер телефона если provider_key = PHONE

Пример запроса:

{
    "userProviderId": "+7XXXXXXXXXX",
    "provider_key": "PHONE"
}

В ответ приходит 200, если запрос правильный, иначе ошибка

Запрос получения кода через звонок

Параметры:
provider_key: text, для подтверждения номером телефона, provider_key = PHONE
userProviderId - text, номер телефона, если provider_key = PHONE

Пример запроса:

{
    "userProviderId": "+7XXXXXXXXXX",
    "provider_key": "PHONE"
}

В ответ приходит 200, если запрос правильный, иначе ошибка

Подтверждение аккаунта с помощью кода

Параметры:
provider_key: text, ддля подтверждения номером телефона(пока только так) provider_key = PHONE
userProviderId - text, номер телефона если provider_key = PHONE
code: text, полученный код

Пример запроса:

{
    "userProviderId": "7XXXXXXXXXX",
    "provider_key": "PHONE",
    "code": "27280"
}

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

Метод выдает информацию по текущему пользователю

Роль: Наблюдатель и выше.

Ответ:

{
  "id": "75bd17cc-642f-4c7c-982e-e0e991907733",    //  id пользователя
  "created": "2017-03-10 16:56:41",          //  дата создания
  "role": {"key": "Editor", "value": "Редактор"}, //роль пользователя. В системе есть роли NoAccess - пользователь без доступа, Editor - обычный пользователь,  Reader - читатель, Admin - администратор (может изменять роли других пользователей, блокировать)
  },
 "actions": [ // список действий пользователя, весь список: GET /actions
      {
          "id": "5858822c-1f21-431b-9cde-a672d2803b2b",
          "key": "generate_report",
      },
      {
        "id": "6ff2a8bd-48d6-4347-b42e-c01d73434fb5",
        "key": "units/update"
      }
  ], 
  "name": "Миша",                  //  имя
  "email": "test@gmail.com",
  "is_approved": true, //подтвержден ли аккаунт
  "is_driver": true, //является ли пользователь водителем
  "need_change_password": true, // Если у пользователя установлен временный пароль, то пользователь должен изменить свой пароль 
  "telegram_chat_id": 12345678910, //id-рассылки для Telegram
  "photos": [{
        "id": "b549d113-88e7-4002-b792-8f76d6694aa3",
        "url": "/photos/b549d113-88e7-4002-b792-8f76d6694aa3_original.png", //путь к оригинальной картинке
        "width": 850,
        "height": 670,
        "param_type": "users" //тип картинки, для пользователей - users
    }, {
        "id": "a8a0d710-01f4-4952-8a0f-35e345f2ad98",
        "url": "/photos/b549d113-88e7-4002-b792-8f76d6694aa3_110.png", //путь к картинке с максимальной стороной в 110px
        "width": 110,
        "height": 86,
        "param_type": "users" //тип картинки, для пользователей - users
    }],
  "code": "092384",                //  id пользователя (rfid)
  "language" : {"key":"en", "value":"English", "type":"languages"},                  //язык пользователя
  "phone" : "+78902334234",
  "details": "Просто текстовое поле",
  "companies": [{"id":"75bd17cc-642f-4c7c-982e-e0e991907733", "name":"Моя первая Компания", "timezone": "UTC+3"}] //доступные пользователю компании
  "active_company": {"id":"75bd17cc-642f-4c7c-982e-e0e991907733", "name":"Моя первая Компания", "timezone": "UTC+3"}
  "settings_web": {}, // настройки в виде json, специфические для web-клиента
  "settings_ios": {},// настройки в виде json, специфические для iOS-клиента
  "settings_android": {},// настройки в виде json, специфические для android-клиента
  "actions_templates": {},// настройки в виде json 
   "actions": [// список действий пользователя, 
      {
          "id": "5858822c-1f21-431b-9cde-a672d2803b2b",
          "key": "generate_report",
      },
    {
        "id": "6ff2a8bd-48d6-4347-b42e-c01d73434fb5",
        "key": "units/update"
    }
  ],
  "units_access": [//Доступ к объектам
      {
            "unit": {
                "id": "0c4095e1-8cf4-4be2-b8b8-5aacf528a6dd"
            },
            "actions": [] // cписок действий, можно выбирать те actions для которых  is_unit_action = true
        },
        {
            "unit": {
                "id": "d0dd6178-fd10-4f49-8627-a386ac35b8c3"
            },
            "actions": [{
                    "id": "051d5caf-b40a-4474-9c25-fb0d83ea4891",
                    "key": "delete_units"
                },
                {
                    "id": "bc7f985c-9641-4d0a-9f6f-8d5214d98105",
                    "key": "update_units"
                }
            ]
        }
    ],
    "units_groups_access": [{ //Доступ к группам
            "units_group": {
                "id": "d7bad56b-bb05-4c9c-830b-ed192a3fa4de"
            },
            "actions": []//список действий, можно выбирать те actions для которых  is_unit_action = true
указанные actions применяются для всех объектов группы
        },
        {
            "units_group": {
                "id": "1769a313-0c20-4ebf-b7f6-7fce00f4f301"
            },
            "actions": [{
                    "id": "051d5caf-b40a-4474-9c25-fb0d83ea4891",
                    "key": "delete_units"
                },
                {
                    "id": "bc7f985c-9641-4d0a-9f6f-8d5214d98105",
                    "key": "update_units"
                }
            ]
        }
    ],
}

Обновить данные текущего пользователя

Обновляет те поля, которые содержатся в запросе. Поля отсутствующие в запросе, не обновляются.

Роль: Редактор и выше.

Пример запроса:

{
  "name": "Миша",          //  имя
}

Параметры:

{
  "role": {"key": "Editor", "value": "Редактор"}, // не доступно для изменения самому пользователю
  "password": "newpw" //новый пароль
  "name": "Миша",     //имя    
  "is_driver": true // делает пользователя водителем       
  "email": "test@gmail.com", //email
  "code": "092384",                //  id пользователя (rfid), доступно для пользователя с ролью Editor
  "language" : {"key":"en"}                  //язык пользователя
  "phone" : "+78902334234" //телефон пользователя
  "details": "Просто текстовое поле"
  "telegram_chat_id": 12345678910,
  "settings_web": {}, // настройки в виде json специфические для web-клиента
  "settings_ios": {},// настройки в виде json специфические для iOS-клиента
  "settings_android": {},// настройки в виде json специфические для android-клиента
}

Ответ:

Возвращает обновленную запись пользователя см. GET /me

Получить информацию о текущем пользователе по его id

Возвращает данные по пользователям переданных id. Возвращаются только те пользователи, у которых есть доступ к текущей компании пользователя, который делает запрос.

Параметры:

ids - может содержать как один id пользователя, так и несколько, разделенных через запятую.

Роль: Читатель и выше.

Ответ:

Массив объектов пользователей, каждый объект которого аналогичен возвращаемому через метод GET /me

Планирование удаления пользователей по их ID

Логика использования, как в DELETE /company/users?ids=:ids
Пользователь с ролью SUPERVISOR может удалять других пользователей.

Роль: Администратор и выше.

Обновить информацию о текущем пользователе по его id.

Обновление пользователя по его id. Пользователь с ролями User, Provider, Executor может менять только себя.

Роль: Администратор и выше.

Параметры и ответ аналогичны методу POST /users

Обновить информацию о текущем пользователе по его id.

Роут для проверки уникальности строки Имя пользователя для использования в качестве логина

Роль: Администратор и выше.

Пример запроса:

{"name": "Иванов Иван Иванович"}

Удаление пользователя по его id

Роль: Администратор и выше.

Создание пользователей, минуя приглашение.

Добавление пользователя с ролью Редактор

Роль: Администратор и выше.

Параметры:

{
  "role": {"key": "EDITOR", "value": "Редактор", "id": "5ac818aa-f66e-4ecd-8981-5bcbafe03255"}, // Роль выбирается из списка ролей; достаточно указать только идентификатор. Получить все роли GET /roles
  "name": "Миша",     //имя 
  "password": "password for user",    
  "is_driver": false // является ли пользователь водителем      
  "email": "test@gmail.com", //email
  "code": "092384",                //  id пользователя (rfid), доступно для пользоваетля с ролью Editor
  "language" : {"key":"en"}               //язык пользователя
  "phone" : "+78902334234" //телефон пользователя
  "details": "Просто текстовое поле"
  "telegram_chat_id": 12345678910, //id-рассылки для Telegram, получается из бота
    "units_groups_access": [{ //Доступ к группам
            "units_group": {
                "id": "d7bad56b-bb05-4c9c-830b-ed192a3fa4de"
            },
            "actions": []//список действий, можно выбирать те actions для которых  is_unit_action = true
указанные actions применяются для всех объектов группы
        },
        {
            "units_group": {
                "id": "1769a313-0c20-4ebf-b7f6-7fce00f4f301"
            },
            "actions": [{
                    "id": "051d5caf-b40a-4474-9c25-fb0d83ea4891",
                    "key": "delete_unit"
                },
                {
                    "id": "bc7f985c-9641-4d0a-9f6f-8d5214d98105",
                    "key": "update_unit"
                }
            ]
        }
    ]
}

Ответ аналогичен PUT /me

Получить пользователей по фильтру

На основании переданных параметров формирует запрос к списку пользователей.

Параметры:

"from": с какой строки возвращать список, 0 - первая. Тип: Integer

"limit": сколько строк возвращать, если 0 - возвращается количество найденных строк. Тип: Integer

"fields":["id", "name"] - поля, которые необходимо включить в результат

"sortField": поле, по которoму нужно делать сортировку (используются следующие поля - name, code, details, role.key, email, phone)

"sortDesc": тип сортировки поля

"value": подстрока для поиска, для User используются следующие поля - name, code, details, role.key, email, phone

Роль: Читатель и выше.

Пример запроса:

Получить пользователей, у которых в полях есть подстрока 'ася', сортировка по полю name в desc режиме (по убыванию)

{
  "sortField": "name",
  "sortDesc": "true",
  "value": "ася",
  "from": 0,
  "limit": 100
}

Ответ:

Возвращает количество найденых записей, если параметр count=0. Возвращает найденные строки, начиная с указанной в from (отсчет с 0) в количестве, указанном в параметре count или менее, если таких не нашлось.

Возвращаемые объекты идентичны получаемым через запрос GET /me

Если ничего не нашлось, возвращается пустой массив.

Добавление аватарки пользователю

Сохраняет фотографии на диске.

Первый - оригинальный с url "/imgs/" + photo.id + "_original.png"

Второй - миниатюра - с наибольшей стороной не больее 110 px, url - "/imgs/" + photo.id + "_110.png"

Оба файла можно использовать для сохранения в поле photos в сущности users

Параметр - id пользователя, которому устанавливаем аватарку.

Ограничение - размер любой стороны передаваемой картинки не может быть больше 3000px

Роль: Читатель и выше.

Ответ:

Возможные ошибки:

422, No File

422, No Image

422, Image size exceeded 3000x3000

Возвращается модель вложения

[
    {
        "id": "af571635-340e-4c4e-a4c0-4eab34a97e8c",
        "url": "/imgs/af571635-340e-4c4e-a4c0-4eab34a97e8c_original.png",
        "width": 858,
        "height": 536,
        "param_type": "users"
    },
    {
        "id": "561518f7-6f1a-4f3c-8b9f-234a91d8ef16",
        "url": "/imgs/af571635-340e-4c4e-a4c0-4eab34a97e8c_70.png",
        "width": 110,
        "height": 43,
        "param_type": "users"
    }
]

Запросить подтверждение пользователя.

Параметры:
userId - ID пользователя

Тела запроса JSON:

Для подтверждение email: { "type": "EMAIL" }

Для подтверждение номер телефона: { "type": "PHONE" }

Можно отправить запрос, если пользователь не подтвержден. Это определяется полем is_approved пользователя для email и is_approved_phone для номера телефона.

В случае успеха, в результате отправляется ответ 200 и отправляется письмо на почту или на телефон, указанную в настройке пользователя.

Иначе возвращается ошибка с кодом 422.

Удаление пользователя из выбранных компаний.

Параметры:

id - ID пользователя

В теле запроса указать список компаний (достаточно указать ID компании)

Изменение роли пользователя в компаниях.

Параметры:

id - ID пользователя

В теле запроса указать:

• Список компаний (достаточно указать ID компании).

• Новую роль в поле role.

Роль: Администратор и выше.

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

Параметры:

id - ID пользователя

В теле запроса указать новую роль в поле role

Пример запроса:

PUT /api_v1/users/a8fa266e-3c70-44c8-933e-adb3fe17063d/change_role_all

{
    "role": {
        "key": "EDITOR",
        "name": "Редактор"
    }
}

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

Параметры:

id - ID пользователя

Роль: Администратор и выше.

Пример запроса:

GET /api_v1/users/679bb60d-3563-4bdd-b7c5-bb72bcef69eb/addable_companies?search=Оду

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

[
    {
        "id": "06fe9426-9e0d-455b-9718-8c4f3400370b",
        "name": "Одуванцик"
    },
    {
        "id": "fb17d37d-e567-421c-805b-4e2e812c1cf7",
        "name": "Одуванцик"
    },
    {
        "id": "fe7b2772-ab94-4248-b32a-ed2da932730d",
        "name": "Одуванцик"
    },
    {
        "id": "3dd6b287-e47b-4cb2-9677-57ae4029d8e7",
        "name": "Одуванцик"
    },
    {
        "id": "fea12912-a5e4-4a65-bff1-43533daefe68",
        "name": "Одуванцик 10.0"
    },
    {
        "id": "2044d5e5-7206-4813-9533-ac89f20409b3",
        "name": "Одуванцикsdfbdfgnnrtfh"
    }
]

Запланированное удаление пользователя из системы.

Роль: Читатель и выше.

Метод запланирует удаление на 24 часа, а в ответ на метод выдается сообщение

200:

{
  "msg": "Мы запланировали удаление вашего аккаунта. У вас есть 24 часа чтобы отменить удаление по ссылке, которую мы вам отправили на почту."
}

Создание пользовательского API_KEY для конкретной компании

Вы можете предоставить доступ только тем пользователям, у которых есть только одна компания и роль ниже администратора.

Параметры запроса:

id - Id пользователя

В теле запроса:

valid_to - срок действия ключа (ссылки).

Роль: Администратор и выше.

Пример запроса:

POST /users/8462404e-99a9-4226-ae14-2f59e0400768/create_token

{
    "valid_to": "2024-06-21 15:00:00"
}

Поле user_company_api_key возвращает ключ, который можно отправлять в запросах в заголовке user_company_api_key.

Поле url возвращает ссылку для авторизации пользователя в компании.

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

{    
  "user_company_api_key": "{{vault:json-web-token}}",  
  "url": "https://dev5.skif.pro/api_v1/login?user_company_api_key={{vault:json-web-token}}"
}

Получение пользовательских настроек для текущего пользователя

Параметр запроса company_id - ID компании, необязательное поле. Если указано, настройки возвращаются только для этой компании.

Описание поля в JSON:

key - ключ настройки, строка

value - значение настройки, строка

version - версия настройки, целое число

Пример:

[
    {
        "id": "d6e6d77d-46f3-4603-b3b8-abe85cb302b8",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "key": "show_item_in_moon",
        "value": "0",
        "version": 1
    },
    {
        "id": "5b04c69c-1fe7-4815-8c3a-d1056a8b5b65",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "key": "show_geozones_in_road_xyz",
        "value": "1",
        "version": 0
    }
]

Сохранение пользовательских настроек для текущего пользователя

Описание поля в JSON:

key - ключ настройки, строка. Для уникальных настроек, которые используются только в одном стенде, рекомендуется использовать префикс или суффикс. Например, show_geozones_on_map_web

value - значение настройки, строка.

version - версия настройки, целое число.

company_id - ID компании, в который сохраняется настройка пользователя.

Пример запроса:

{
    "key": "show_item_in_moon",
    "value": "1"
}

Ответ возвращает массив JSON: все настройки пользователя:

Пример:

[
    {
        "id": "d6e6d77d-46f3-4603-b3b8-abe85cb302b8",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "key": "show_item_in_moon",
        "value": "0",
        "version": 1
    },
    {
        "id": "5b04c69c-1fe7-4815-8c3a-d1056a8b5b65",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "key": "show_geozones_in_road_xyz",
        "value": "1",
        "version": 0
    }
]

Сохранение настройки пользователя в компании:

{
    "key": "show_geozones_in_road_3",
    "value": "1",
    "company_id": "3e70f167-9fad-4753-bccf-d7d47c2c648c"
}

Ответ:

[
    {
        "id": "48379173-7c56-457c-be29-f329fbd284c5",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "company_id": "3e70f167-9fad-4753-bccf-d7d47c2c648c",
        "key": "show_geozones_in_road_xyz_ssssssssss",
        "value": "1",
        "version": 0
    },
    {
        "id": "0ba785ce-5fcb-4b88-b8bc-88e0749de321",
        "user_id": "a4b5fde8-9b70-4425-bd75-bde7f12c9f87",
        "company_id": "3e70f167-9fad-4753-bccf-d7d47c2c648c",
        "key": "show_geozones_in_road_3",
        "value": "1",
        "version": 0
    }
]

Возможность переключение под пользователем без запроса пароля

Параметры запроса:

user_id - ID пользователя для переключения.

company_id - ID компании для переключения.

Роль: Администратор и выше.

Пример запроса:

https://admin-dev.skif.pro/api_v1/change/user/2f583b2b-a7d6-4d93-94b3-da6eedab69f0/company/459b2824-0035-499d-8062-baccb2ae5581

В результате пользователь перенаправляется на страницу в которой пользователь авторизуется под выбранным пользователем.

Для авторизованного пользователя таким способом возвращается в GET /me поле another_user: true

Получить все записи справочника Dictionary с указанным типом.

Описание параметров:

dicType - тип записей, которые необходимо получить.

Может принимать следующие значения:

admin_modules
color_code
customfield_groups
formula
geo_icon
geozone_type
notification_type
periodic_type
report_template_table_grouping
report_template_table_type
sensor_type
terminal_type
trip_activation_type
trip_passage_order_type
unit_icon
unit_type
weekdays_type

Пример запроса:

GET /dictionaries/unit_type

возвращает все часовые пояса в формате (пример для английской локали):

[{
    "type": "unit_type",
    "key": "farm_equipment",
    "value": "Farm equipment"
}, {
    "type": "unit_type",
    "key": "house",
    "value": "House"
    }
}]

Описание параметров ответа:
type - тип справочника,
key - ключ справочника,
value - перевод справочника на язык пользователя

В случае отсутствия записей переданного типа возвращает пустой массив []

Получить все записи справочника Dictionary

Пример запроса:

GET /dictionaries

возвращает все справочники (пример для английской локали) сортируя по type:

[{
    "key": "admin_geozones",
    "type": "admin_modules",
    "value": "Geozones"
},
...
 {
    "type": "unit_type",
    "key": "house",
    "value": "House"
    }
},
...
{
    "key": "monday",
    "type": "weekdays_type",
    "value": "Понедельник"
}
]

Описание параметров ответа:
type - тип справочника, все возможные знечения:
admin_modules
color_code
customfield_groups
formula
geo_icon
geozone_type
notification_type
periodic_type
report_template_table_grouping
report_template_table_type
sensor_type
terminal_type
trip_activation_type
trip_passage_order_type
unit_icon
unit_type
weekdays_type
key - ключ справочника,
value - перевод справочника на язык пользователя

Получить все записи справочника Properties с указанным типом.

Справочник 'Properties' предназначен ТОЛЬКО для микросервиса auth и включает в себя только информацию о юзере.

Описание параметров:

propertiesType - тип записей, которые необходимо получить.

Может принмать следующие значения:

languages (языки),

timezones (часовые пояса)

roles (роли)

dateformats (форматы даты)

timeformats (форматы времени)

Пример запроса:

GET /properties/timezones

Возвращает все часовые пояса в формате (пример для английской локали):

[{
    "type": "timezones",
    "key": "UTC+4:30",
    "value": "Kabul, Afghanistan (+4:30)"
}, {
    "type": "timezones",
    "key": "UTC+6:30",
    "value": "Yangon, Myanmar (+6:30)"
    }
}]

Описание параметров ответа:
type - тип справочника,
key - ключ справочника,
value - перевод справочника на язык пользователя

В случае отсутствия записей переданного типа возвращает пустой массив []

Получить все записи справочника Properties

Справочник 'Properties' предназначен ТОЛЬКО для микросервиса auth и включает в себя только информацию о пользователе.

Пример запроса:

GET /properties

Возвращает все записи (пример для английской локали):

[{
    "key": "yyyy-MM-dd",
    "type": "dateformats",
    "value": "yyyy-MM-dd(2014-01-25, 1987-12-02)"
}, 
...
{
    "key": "NO_ACCESS",
    "type": "roles",
    "value": "NoAccess"
}
...
{
    "key": "UTC+5",
    "type": "timezones",
    "value": "(GMT + 05: 00) Yekaterinburg, Islamabad, Karachi, Tashkent"
}
}]

Описание параметров ответа:
type - тип справочника, все возможные значения:

languages - языки
timezones - часовые пояса
roles - роли
dateformats - форматы даты
timeformats - форматы времени
key - ключ справочника
value - перевод справочника на язык пользователя

Получить доступ текущего пользователя к сущностям системы

Формат возвращаемых данных:

{
    "edit_classes_fields": [{  //доступ на редактирование к полям сущностей в целом
        "type": "users",
        "fields": ["name", "photo", "email", "phone", "code"]
    }],
    "edit_objects_fields": [{ //доступ на редактирование к полям конкретной сущности
        "type": "users",
        "id": "23498320-32492-3294-23989487",
        "fields": ["name", "photo", "email", "phone", "code"]
    }],
    "actions": ["btmCreateUser", "btmDeleteUser", "btmSendCommand"]  //доступ к действиям
}

Описание параметров ответа:

edit_classes_fields - ключ тега, содержащий массив ограничений на редактирование к сущности

type - ключ сущности, возможные значения users, units, geozones, routes, report_templates, notifications_templates

fields - массив полей доступных пользователю на редактирование

edit_objects_fields - ключ тега, содержащий массив ограничений, на редактирование конкретных сущностей

id - идентификатор сущности, к которой применяется ограничение

actions - ключ тега, содержащий массив ключей действий, к которым имеет доступ пользователь

Доступ определяется на основании роли пользователя к текущей компании и сущностям, к которым он имеет эксклюзивный доступ (например, собственная карточка пользователя)

Запрос на получение обязательных custom_fields

Custom_fields юнита делятся на 2 типа - обязательные и необязательные (кастомные).

Обязательные custom_fields это поля, которые должны присутствовать у каждого юнита. При создании/изменении юнита лучше всего передавать эти обязательные поля со значениями, установленными юзером. Если бэкенд не обнаружит в юните какого-то обязательного поля, то оно будет создано в нём автоматически, значение будет взято из default_value.
Бэкенд проверяет значения через паттерн. В случае не соответствия паттерну, будет выброшена ошибка.

Необязательные поля - произвольные поля, созданные юзером дополнительно. Никак не проверяются на стороне бэкенда. По состоянию на май 2020г. используются как поля для дополнительной информации (пояснительные) и не участвуют в каких-либо расчетах.

Custom_field юнита имеет следующие параметры
name - имя поля, которое отображается в интерфейсе. У обязательных полей - не изменяемо (поэтому пытаться изменить его название в юните не имеет смысла). У НЕобяз. - изменяемое, произвольное.
key - ключ custom_fields. Все поля определяются и распознаются бэкендом именно по ключу. У обяз.полей - ключ константный, у необяз. полей - ключ произвольный, договорились использовать key такой же как и name.
value - значение, которое пользователь присвоил этому кастом филду.

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

[
    {
        "name": "Мин. объем заправки",
        "key": "fuel_fillings_minfilling",
        "default_value": "10",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 1,
        "show_in_monitoring": false
    },
    {
        "name": "Расход летом (л/100км.)",
        "key": "fuel_consumption_summerconsump",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 1,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. время стоянки (сек)",
        "key": "tripdetector_minparktime",
        "default_value": "300",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 1,
        "show_in_monitoring": false
    },
    {
        "name": "Аналитик",
        "key": "analyst",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 1,
        "show_in_monitoring": false
    },
    {
        "name": "Игнор-ть сообщ-я после начала движения",
        "key": "fuel_fillings_msgignorestart",
        "default_value": "60",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 2,
        "show_in_monitoring": false
    },
    {
        "name": "Расход зимой (л/100км.)",
        "key": "fuel_consumption_winterconsump",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 2,
        "show_in_monitoring": false
    },
    {
        "name": "Коэф. пробега",
        "key": "advanced_mileagecoeff",
        "default_value": "1",
        "pattern": "^\\d{1,8}((,|.)\\d{1,8})?$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 2,
        "show_in_monitoring": false
    },
    {
        "name": "Установщик",
        "key": "installer",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 2,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. время остановки для опр-ия слива",
        "key": "fuel_fillings_minstaytheft",
        "default_value": "60",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 3,
        "show_in_monitoring": false
    },
    {
        "name": "На холостом ходу летом (л./час.)",
        "key": "fuel_math_idlingsummer",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 3,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. скорость движ-я (км/ч)",
        "key": "tripdetector_minmovespeed",
        "default_value": "3",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 3,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. объем слива",
        "key": "fuel_fillings_minitheft",
        "default_value": "10",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 4,
        "show_in_monitoring": false
    },
    {
        "name": "На холостом ходу зимой (л./час.)",
        "key": "fuel_math_idlingwinter",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 4,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. расст-ие поездки (м)",
        "key": "tripdetector_mintripdist",
        "default_value": "100",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 4,
        "show_in_monitoring": false
    },
    {
        "name": "Дата установки(формат год-месяц-день, например 2019-03-07)",
        "key": "install_date",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 4,
        "show_in_monitoring": false
    },
    {
        "name": "Коэф. при движении под нагрузкой",
        "key": "fuel_math_coeffunderload",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 5,
        "show_in_monitoring": false
    },
    {
        "name": "Макс. интервал между сообщ-ми (сек)",
        "key": "advanced_maxintervalmsg",
        "default_value": "3600",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 5,
        "show_in_monitoring": false
    },
    {
        "name": "Место установки в ТС",
        "key": "install_place",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 5,
        "show_in_monitoring": false
    },
    {
        "name": "Первый месяц зимы (январь-1)",
        "key": "fuel_consumption_winterfrom",
        "default_value": "11",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 6,
        "show_in_monitoring": false
    },
    {
        "name": "Макс. расст-ие между сообщ-ми (м)",
        "key": "tripdetector_maxdistancemsg",
        "default_value": "1000",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 6,
        "show_in_monitoring": false
    },
    {
        "name": "Серийный номер терминала",
        "key": "serial_number",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 6,
        "show_in_monitoring": false
    },
    {
        "name": "Последний месяц зимы (январь-1)",
        "key": "fuel_consumption_winterto",
        "default_value": "3",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 7,
        "show_in_monitoring": false
    },
    {
        "name": "Мин. время поездки (сек)",
        "key": "tripdetector_mintriptime",
        "default_value": "60",
        "pattern": "^\\d+$",
        "type": "text",
        "group": "cf_trips",
        "values": [],
        "sort": 7,
        "show_in_monitoring": false
    },
    {
        "name": "Серийный номер ДУТ",
        "key": "serial_number_dut",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 7,
        "show_in_monitoring": false
    },
    {
        "name": "Стоимость (1 л.)",
        "key": "fuel_price",
        "default_value": "0",
        "pattern": "^[0-9]*\\.?[0-9]+$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 8,
        "show_in_monitoring": false
    },
    {
        "name": "Опр-ие движ-я",
        "key": "key_tripdetector_movedetect",
        "default_value": "speedkph",
        "pattern": "^[a-zA-Zа-яА-Я\\.\\_]*$",
        "type": "list",
        "group": "cf_trips",
        "values": [
            {
                "key": "speedkph",
                "value": "Скорость"
            },
            {
                "key": "ignition",
                "value": "Зажигание"
            }
        ],
        "sort": 8,
        "show_in_monitoring": false
    },
    {
        "name": "Серийный номер пломбы ДУТ",
        "key": "dut_seal_serial_number",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 8,
        "show_in_monitoring": false
    },
    {
        "name": "Определение пробега",
        "key": "tripdetector_mileagedetect",
        "default_value": "mileage_GPS",
        "pattern": "^[a-zA-Zа-яА-Я\\.\\_]*$",
        "type": "list",
        "group": "cf_trips",
        "values": [
            {
                "key": "mileage_GPS",
                "value": "GPS"
            },
            {
                "key": "mileage_mileage_sensor",
                "value": "Cенсор"
            },
            {
                "key": "mileage_relative_mileage",
                "value": "Относительный пробег"
            },
            {
                "key": "mileage_GPS_ignition",
                "value": "GPS зажигание"
            }
        ],
        "sort": 9,
        "show_in_monitoring": false
    },
    {
        "name": "Гос номер",
        "key": "license_plate_number",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 9,
        "show_in_monitoring": false
    },
    {
        "name": "Определение моточасов",
        "key": "key_motohourdetector",
        "default_value": "ignition",
        "pattern": "^[a-zA-Zа-яА-Я\\.\\_]*$",
        "type": "list",
        "group": "cf_motohours",
        "values": [
            {
                "key": "ignition",
                "value": "Зажигание"
            },
            {
                "key": "abs_motohours",
                "value": "Абсолютные моточасы"
            },
            {
                "key": "relative_motohours",
                "value": "Относительные моточасы"
            }
        ],
        "sort": 10,
        "show_in_monitoring": false
    },
    {
        "name": "Норма часов в день",
        "key": "hours_rate",
        "default_value": "8",
        "pattern": "^((2[0-4]|1[0-9]|[0-9])|((2[0-3]|1[0-9]|[0-9])\\.[0-9]+))$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 10,
        "show_in_monitoring": false
    },
    {
        "name": "Дата блокировки(формат год-месяц-день, например 2019-03-07)",
        "key": "block_date",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 11,
        "show_in_monitoring": false
    },
    {
        "name": "КП",
        "key": "kp",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 12,
        "show_in_monitoring": false
    },
    {
        "name": "ДУТ",
        "key": "dut",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 13,
        "show_in_monitoring": false
    },
    {
        "name": "Вторая sim",
        "key": "second_sim",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 14,
        "show_in_monitoring": false
    },
    {
        "name": "Серийный номер ДУТ 1",
        "key": "serial_number_dut_1",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 15,
        "show_in_monitoring": false
    },
    {
        "name": "Серийный номер ДУТ 2",
        "key": "serial_number_dut_2",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 16,
        "show_in_monitoring": false
    },
    {
        "name": "Марка машины",
        "key": "brand_name",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 17,
        "show_in_monitoring": false
    },
    {
        "name": "Вид топлива (бенз., д/т)",
        "key": "fuel_type",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 18,
        "show_in_monitoring": false
    },
    {
        "name": "Марка горючего",
        "key": "fuel_mark",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_fuel",
        "values": [],
        "sort": 19,
        "show_in_monitoring": false
    },
    {
        "name": "Код марки",
        "key": "brand_code",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 20,
        "show_in_monitoring": false
    },
    {
        "name": "Видео устройство",
        "key": "video_device_name",
        "default_value": "",
        "pattern": "^(?:|CARVIS)$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 21,
        "show_in_monitoring": false
    },
    {
        "name": "ID-видео устройства",
        "key": "video_device_id",
        "default_value": "",
        "pattern": "^.*$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 22,
        "show_in_monitoring": false
    },
    {
        "name": "Камеры",
        "key": "video_cameras",
        "default_value": "",
        "pattern": "^(|\\d+(?:[\\t]*,[\\t]*\\d+)*+)$",
        "type": "text",
        "group": "cf_etc",
        "values": [],
        "sort": 23,
        "show_in_monitoring": false,
        "hint": "Несколько числовых значений разделенных запятой, например 0,1,3,7"
    }
]