Изменения в версии 1.2017-10-16

Методы API Сайта

Все запросы в ходе интеграции осуществляются методом POST в кодировке UTF-8 и Content-Type: application/json. Все значения параметров интерпретируются как строки, если это не оговорено дополнительно.

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

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

Запрос UserRequest (JSON)

	Параметр	Пример значения	Обязательный	Описание
добавлено возможное значение	permissions	[USE_DICTIONARY]	нет	Список разрешений для пользователя. Для вычисления signature все значения собираются в строчку без каких либо разделителей. Если при создании пользователя никаких разрешений не указано, то считается, что пользователь создаётся с разрешениями по умолчанию, а именно: ["USE_DICTIONARY "]. Если необходимо создать пользователя, которому не разрешено работать со словарём, то необходимо передать пустой список разрешений: []. Допустимые разрешения: USE_DICTIONARY — Работа с корпоративным словарём (добавлять, редактировать) DISABLE_CICERO — Работа с инструментами вкладки Красота ЗАПРЕЩЕНА! DISABLE_QUALITY — Работа с инструментами вкладки Качество ЗАПРЕЩЕНА! DISABLE_API_SECONDARY_ORFO_CHECKS — Повторная проверка через API ЗАПРЕЩЕНА!
новый параметр	qualityKinds	["mkWater"]	нет	Список типов аннотаций вкладки «Качество», которые нужно показывать пользователю после проверки. Пустой список означает, что пользователю нужно будет выбирать их каждый раз после проверки документа. Возможные значения списка: mkWater — водность текста
алгоритм изменён	signature	5eb63bbbe01eeed093cb22bb8f5acdc3	да	Электронная подпись запроса, формируется по алгоритму `md5(time + company + login + name + password + permissions + orthoKinds + ciceroKinds + qualityKinds + API_SECRET_KEY )`.

Параметр

Пример значения

Обязательный

Описание

добавлено возможное значение

permissions

[USE_DICTIONARY]

нет

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

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

USE_DICTIONARY — Работа с корпоративным словарём (добавлять, редактировать)
DISABLE_CICERO — Работа с инструментами вкладки Красота ЗАПРЕЩЕНА!
DISABLE_QUALITY — Работа с инструментами вкладки Качество ЗАПРЕЩЕНА!
DISABLE_API_SECONDARY_ORFO_CHECKS — Повторная проверка через API ЗАПРЕЩЕНА!

новый параметр

qualityKinds

["mkWater"]

нет

Список типов аннотаций вкладки «Качество», которые нужно показывать пользователю после проверки. Пустой список означает, что пользователю нужно будет выбирать их каждый раз после проверки документа. Возможные значения списка:

mkWater — водность текста

алгоритм изменён

signature

5eb63bbbe01eeed093cb22bb8f5acdc3

да

Электронная подпись запроса, формируется по алгоритму `md5(time + company + login + name + password + permissions + orthoKinds + ciceroKinds + qualityKinds + API_SECRET_KEY )`.

POST https://litera5.ru/api/pub/check-ogxt/

Запускает проверку документа в формате ogxt без участия пользователя.

Запрос на проверку документа CheckOgxtRequest (JSON)

	Параметр	Пример значения	Обязательный	Описание
добавлено возможное значение	profile	ortho	нет	Тип проверки документа (закладка «правописание» (ortho), «красота» (cicero) или «качество» (quality)). В зависимости от типа проверки подключаются различные наботы правил на которые проверяется текст.