Изменения в версии 1.2015-09-15
Методы API Сайта
Все запросы в ходе интеграции осуществляются методом POST в кодировке UTF-8 и Content-Type: application/json. Все значения параметров интерпретируются как строки, если это не оговорено дополнительно.
POST https://litera5.ru/api/pub/setup/
Настройки API Партнёра
Запрос SetupRequest (JSON)
| Параметр | Пример значения | Обязательный | Описание | |
|---|---|---|---|---|
| новый параметр | getStats | true | нет | true или false, по умолчанию настройка выключена. Если настройка включена, то в модели результата вместе с обработанным текстом будет модель статистического отчёта в формате JSON. |
| изменён алгоритм | signature | 5eb63bbbe01eeed093cb22bb8f5acdc3 | да | Электронная подпись запроса, формируется по алгоритму `md5(time + company + onSaveChecked + onIFrameFailure + returnIcon + returnCaption + cancelIcon + cancelCaption + allowResizeImages + showCancelButton + editorCss + getStats + API_SECRET_KEY )`. Если какие-то поля отсутствуют в запросе, то при вычислении подписи они заменяются пустой строкой. |
Методы API Партнёра
Все запросы в ходе интеграции осуществляются методом POST в кодировке UTF-8 и Content-Type: application/json. Все значения параметров интерпретируются как строки, если это не оговорено дополнительно.
POST on-save-corrected (SetupRequest.onSaveCorrected)
Партнёру необходимо реализовать этот метод в своей CMS для того, чтобы сохранять документы откорректированные в системе Сайта.
Запрос SaveCorrectedRequest (JSON)
| Параметр | Пример значения | Обязательный | Описание | |
|---|---|---|---|---|
| новый параметр | stats | {"annotations": [], "words": []} | нет | JSON модель статистического отчёта (описание формата модели). Присутствует только если в методе setup настроен параметр getStats. |