litera5.api.v1.2015-05-15

Изменения в версии 1.2015-05-15

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

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

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

Настройки API Партнёра

Запрос SetupRequest (JSON)

 ПараметрПример значенияОбязательныйОписание
новый параметрeditorCsshttp://cms.company.ru/editor.cssнетПолный путь до файла стилей для редактора. (пример файла стилей есть в архиве с примерами для PHP)
изменён алгоритмsignature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + company + onSaveChecked + onIFrameFailure + returnIcon + returnCaption + cancelIcon + cancelCaption + allowResizeImages + showCancelButton + editorCss + API_SECRET_KEY )`. Если какие-то поля отсутствуют в запросе, то при вычислении подписи они заменяются пустой строкой.

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

Инициирует процедуру проверки документа. 

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

 ПараметрПример значенияОбязательныйОписание
новый параметрtitleЗаголовок документанетДополнительное поле. Заголовок документа для проверки. Дополнительные поля будут добавлены в специальную форму для дополнительной проверки.
новый параметрdescriptionКраткое описаниенетДополнительное поле. Краткое описание страницы для проверки.
новый параметрkeywordsКлючевые слованетДополнительное поле. Ключевые слова страницы для проверки.
изменён алгоритмsignature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + company + login + token + document + name + title + description + keywords + html + API_SECRET_KEY)`.

Методы API Партнёра

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

POST on-save-corrected (SetupRequest.onSaveCorrected)

Партнёру необходимо реализовать этот метод в своей CMS для того, чтобы сохранять документы откорректированные в системе Сайта.

Запрос SaveCorrectedRequest (JSON)

 ПараметрПример значенияОбязательныйОписание
новый параметрtitleЗаголовок документанетОтредактированный заголовок документа
новый параметрdescriptionКраткое описаниенетОтредактированное краткое описание
новый параметрkeywordsКлючевые слованетОтредактированные ключевые слова
изменён алгоритмsignature5eb63bbbe01eeed093cb22bb8f5acdc3даЭлектронная подпись запроса, формируется по алгоритму `md5(time + token + title + description + keywords + html + API_SECRET_KEY)`