litera5.api.v1.2017-04-12

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

Доблено два новых метода

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

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

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

ПараметрПример значенияОбязательныйОписание
time1410103972даТекущее время в формате unix timestamp (количество секунд с 1970 года)
companyhitsoftдаИдентификатор Партнёра указанный при регистрации на Сайте .
loginuserдаЛогин пользователя на Сайте, который работает с документом.
profileorthoнетТип проверки документа (закладка "правописание" (ortho) или "красота" (cicero)). В зависимости от типа проверки подключаются различные наботы правил на которые проверяется текст.
document539557f78dfdedee48e136f8нетИдентификатор документа в системе Сайта. Если указан, то будет продолжена работа над тем же самым документом, если нет, то будет создан новый документ. Пожалуйста, обратите внимание на то обстоятельство, что в данный момент в Литере5 с документом может работать только один пользователь. Поэтому несмотря на то, что в CMS с документом могут работать различные пользователи, при работе с одним и тем же документом в API имеет смысл передавать в `login` не идентификатор текущего пользователя CMS Партнёра, а идентификатор пользователя создавшего данный документ в Литере5 (того пользователя в результате проверки которого был выдан этот `document`). В противном случае API выдаст ошибку о недостатке прав пользователя на работу с документом.
nameНазвание документанетНазвание документа (title, subject). Если не указано, то будет сформировано автоматически из текста.
html<h1>Загаловак</h1><p>текст с ашипками</p>да

Оригинальные текст для проверки в формате html. Если указан `document`, то текст заместит собой текст выбранного `document`. Этот текст используется для отображения проверок в интерфейсе Литеры.

ogxt

Загаловак
текст с ашипками
----------------------------------
[{header: }] 

даТекст для проверки в формате ogxt полученный из текста html, например при помощи утилит ogxt-utils
signature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + company + login + profile + document + name + html + ogxt + API_SECRET_KEY)`.

Ответ на запрос на проверку документа CheckOgxtResponse (JSON)

ПараметрПример значенияОбязательныйОписание
time1410103972даТекущее время в формате unix timestamp (количество секунд с 1970 года)
document539557f78dfdedee48e136f8даИдентификатор документа в системе Сайта созданный в результате запроса.
check539557f78dfdedee48e136f9даИдентификатор проверки инициированной запросом (потребуется для получения результатов проверки и уточнения статуса проверки)
signature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись ответа, формируется по алгоритму `md5(time + document + check + API_SECRET_KEY)`

В случае ошибки в запросе, ошибка аутентификации, неверного идентификатора документа и тому подобное, в качестве ответа будет получен соответствующий HTTP код из серии 4xx (Client Error), а в теле ответа будет utf8 текст с детальным описанием ошибки.

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

Проверяет текущее состояние проверки и получает результаты в случае её окончания

Запрос на результаты проверки документа CheckOgxtResultsRequest (JSON)

ПараметрПример значенияОбязательныйОписание
time1410103972даТекущее время в формате unix timestamp (количество секунд с 1970 года)
companyhitsoftдаИдентификатор Партнёра указанный при регистрации на Сайте .
check539557f78dfdedee48e136f8даИдентификатор проверки в системе Сайта полученный в CheckOgxtResponse при запросе check-ogxt.
signature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + company + check + API_SECRET_KEY)`.

Ответ на запрос на результаты проверки документа CheckOgxtResultsResponse (JSON)

ПараметрПример значенияОбязательныйОписание
time1410103972даТекущее время в формате unix timestamp (количество секунд с 1970 года)
stateCHECKED_SUCCESSдаТекущее состояние проверки. Все возможные значения можно разделить на три группы: Проверка благополучно завершена (CHECKED_SUCCESS), проверка не удалась (ESTIMATED_ERROR, ESTIMATED_REJECT, CANCELLED, REJECTED, CHECKED_ERROR) и проверка ещё не закончилась (CREATED, UPLOADED, WAITING_ESTIMATION, ESTIMATING, ESTIMATED_SUCCESS, WAITING_CHECK, CHECKING)
progress100даПрогресс проверки в целых процентах (число)
messageПроверка завершенадаДополнительное текстовое сообщение разъясняющее текущее состояние (в случае ошибочных состояний здесь будет поясняющее объяснение сложившейся ситуации)
html<h1>Загаловак<h1><p>текст с ашипками</p>нетHTML который был подвергнут проверке в который можно встраивать результаты (на случай, если текст уже изменился)
annotations[]нетJSON модель результатов проверки ( описание формата модели ).
stats{"annotations": [], "words": []}нетJSON модель статистического отчёта ( описание формата модели ).
signature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись ответа, формируется по алгоритму `md5(time + state + progress + message + html + API_SECRET_KEY)`

В случае ошибки в запросе, ошибка аутентификации, неверного идентификатора документа и тому подобное, в качестве ответа будет получен соответствующий HTTP код из серии 4xx (Client Error), а в теле ответа будет utf8 текст с детальным описанием ошибки.