Изменения в версии 1.2015-03-18
Методы API Сайта
Все запросы в ходе интеграции осуществляются методом POST в кодировке UTF-8 и Content-Type: application/json. Все значения параметров интерпретируются как строки, если это не оговорено дополнительно.
POST https://litera5.ru/api/pub/setup/
Настройки API Партнёра
Запрос SetupRequest (JSON)
| Параметр | Пример значения | Обязательный | Описание | |
|---|---|---|---|---|
| новый параметр | cancelIcon | http://cms.company.ru/cancel-logo.png | нет | URL картинки размером 32х32, которая будет размещена на кнопке "Отменить правки и вернуться в CMS". |
| новый параметр | cancelCaption | Отменить и вернуться в CMS | нет | Подпись для кнопки "Отменить правки и вернуться в CMS". |
| новый параметр | allowResizeImages | false | нет | true или false, по умолчанию настройка включена. Если настройка включена, то в редакторе можно изменять размер встроенных картинок. |
| новый параметр | showCancelButton | true | нет | true или false, по умолчанию выключена. Если настройка включена, то в редакторе появляется кнопка "Отменить правки и вернуться в CMS", при нажатии на которую в CMS будет отправлен пустой запрос `on-save-corrected` (без указания параметра html). Это означает, что пользователь не хочет сохранять сделанные изменения. |
| изменён алгоритм | signature | 5eb63bbbe01eeed093cb22bb8f5acdc3 | да | Электронная подпись запроса, формируется по алгоритму `md5(time + company + onSaveChecked + onIFrameFailure + returnIcon + returnCaption + cancelIcon + cancelCaption + allowResizeImages + showCancelButton + API_SECRET_KEY )`. Если какие-то поля отсутствуют в запросе, то при вычислении подписи они заменяются пустой строкой. |
POST https://litera5.ru/api/pub/check/
Инициирует процедуру проверки документа.
Запрос на проверку документа CheckRequest (JSON)
| Параметр | Пример значения | Обязательный | Описание | |
|---|---|---|---|---|
| Расширено описание. | html | <h1>Загаловак</h1><p>текст с ашипками</p> | нет | Собственно текст для проверки в формате html. Если указан `document`, и не указан `html`, тогда откроется редактор с последней версией документа сохранённого на Сайте. Если текст указан, то он заместит собой текст выбранного `document` или инициирует процесс создания нового документа. Либо `documentId` либо `html` должно быть обязательно указано. Для того, чтобы в редакторе показывались иллюстрации к тексту, нужно в поле `src` тэга `img` указывать абсолютный путь к файлу иллюстрации. Если вам необходимо сохранить какие-то дополнительные атрибуты тэгов, то их можно сохранить в атрибутах с префиксом `data-litera5-api-`. Например, в вашей базе данных хранятся относительные пути к иллюстрациям, или пути с переменными чтобы редактор смог корректно отобразить иллюстрации в атрибут `src` нужно поместить абсолютную ссылку, но хочется сохранить и внутреннюю ссылку, её можно поместить в атрибут `data-litera5-api-src` при отправке на проверку и восстановить из этой ссылке при получении результатов. |
Методы API Партнёра
Все запросы в ходе интеграции осуществляются методом POST в кодировке UTF-8 и Content-Type: application/json. Все значения параметров интерпретируются как строки, если это не оговорено дополнительно.
POST on-save-corrected (SetupRequest.onSaveCorrected)
Партнёру необходимо реализовать этот метод в своей CMS для того, чтобы сохранять документы откорректированные в системе Сайта.
Запрос SaveCorrectedRequest (JSON)
| Параметр | Пример значения | Обязательный | Описание | |
|---|---|---|---|---|
| стал не обязательным, добавлено новое поведение | html | <h1>Заголовок</h1><p>текст без ошибок</p> | нет | Отредактированный текст документа. Если не указан, то это означает, что пользователь нажал кнопку "Отменить правки и вернуться в CMS", то есть решил не сохранять сделанные правки в CMS. |