Орфограммка
Библиотека Орфограммки > API > litera5.api.v1 > litera5.api.v1.2017-11-13

litera5.api.v1.2017-11-13

POST https://litera5.ru/api/pub/user/

Функция для создания и обновления информации о пользователях. Если пользователь с указанным логином существует в базе, то его пароль или имя будут установлены в соответствие с запросом. Если же пользователя с указанным логином не существует, то он будет создан в базе данных Сайта.

Запрос UserRequest (JSON)

 ПараметрПример значенияОбязательныйОписание
часть возможных значений помечена как устаревшееpermissions[USE_DICTIONARY]нет

Список разрешений для пользователя. Для вычисления signature все значения собираются в строчку без каких либо разделителей. Если при создании пользователя никаких разрешений не указано, то считается, что пользователь создаётся с разрешениями по умолчанию, а именно: ["USE_DICTIONARY "]. Если необходимо создать пользователя, которому не разрешено работать со словарём, то необходимо передать пустой список разрешений: [].

Допустимые разрешения:

  • USE_DICTIONARY — Работа с корпоративным словарём (добавлять, редактировать)
  • DISABLE_CICERO — Работа с инструментами вкладки Красота ЗАПРЕЩЕНА! (Этот разрешение устаревшие, советуем пользоваться параметром checksCicero для настройки возможности работы с вкладкой)
  • DISABLE_QUALITY — Работа с инструментами вкладки Качество ЗАПРЕЩЕНА! (Этот разрешение устаревшие, советуем пользоваться параметром checksQuality для настройки возможности работы с вкладкой)
  • DISABLE_API_SECONDARY_ORFO_CHECKS — Повторная проверка через API ЗАПРЕЩЕНА! (Этот разрешение устаревшие, советуем пользоваться параметром checksOrtho для настройки возможности работы с вкладкой)
  • Если у пользователя уже заданы параметры запретов-разрешений, а вы хотите перейти на работу с новыми параметрами: checksCicero, checksQuality, checksOrtho — вам нужно выполнить запрос со списком разрешений из одного элемента ["USE_DICTIONARY"] либо с пустым: [] — если вы хотите также и работу со словарём запретить.
новый параметрchecksOrtho-1нетМаксимальное количество проверок грамотности (не может быть 0, минимальное значение 1, первая проверка запускается автоматически). -1 означает, что можно делать сколько угодно проверок. По умолчанию -1 (сколько угодно проверок).
новый параметрchecksCicero0нетМаксимальное количество проверок красоты. -1 означает, что можно делать сколько угодно проверок. 0 означает, что вкладки "Красота" не будет вовсе. По умолчанию -1 (сколько угодно проверок).
новый параметрchecksQuality2нетМаксимальное количество проверок качества. -1 означает, что можно делать сколько угодно проверок. 0 означает, что вкладки "Качество" не будет вовсе. По умолчанию -1 (сколько угодно проверок).
новый параметрchecksTotal3нетМаксимальное количество проверок суммарно для всех вкладок. -1 означает, что можно делать сколько угодно проверок. По умолчанию -1 (сколько угодно проверок). Если задано ограничение checksTotal, например: 10, то когда пользователь выполнит десятую проверку, во всех вкладках у него исчезнут кнопки "Проверить...", и одиннадцатую проверку он выполнить не сможет ни в одной из вкладок, даже если для каждой конкретной вкладки вы не задавали ограничений.
алгоритм изменёнsignature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + company + login + name + password + permissions + orthoKinds + ciceroKinds + qualityKinds + checksOrtho + checksCicero + checksQuality + checksTotal + API_SECRET_KEY )`.