api l5 setup

POST setup

• Метод: POST
• URL: https://litera5.ru/api/pub/setup/
• Content-type: application/json

Метод для настройки параметров работы с API.

На странице Настройка есть менее формальное описание, с примерами использования и более подробным функциональным описанием параметров.

Запрос

interface SetupRequest {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Идентификатор Партнёра, указанный при регистрации в Литере.
     * 
     * @пример: "my-company"
     * @обязательный: да
     */
    company: string;
    
    /**
     * URL в CMS Партнёра , на который будет отправлен запрос по окончании 
     * работы Пользователя с документом. Так как ответ будет передан запросом 
     * POST, то `onSaveCorrected` не должен содержать параметров в формате 
     * "?param=value&param1=value".
     * 
     * @пример: "http://cms.my-company.ru/save_corrected.php"
     * @обязательный: нет
     */
    onSaveCorrected: string;
    
    /**
     * URL в CMS Партнёра, на который будет отправлен запрос в случае 
     * критической ошибки. Так как ответ будет передан запросом POST, то 
     * `onIFrameFailure` не должен содержать параметров в формате 
     * "?param=value&param1=value".
     * 
     * @пример: "http://cms.my-company.ru/iframe_failure.php"
     * @обязательный: нет
     */
    onIFrameFailure: string;
    
    /**
     * URL в CMS Партнёра, на который будет отправлен запрос со статистикой 
     * по окончании первичной проверки документа пользователя. Так как ответ 
     * будет передан запросом POST, то `onInitialStats` не должен содержать 
     * параметров в формате "?param=value&param1=value".
     * 
     * @пример: "http://cms.my-company.ru/initial_stats.php"
     * @обязательный: нет
     */
    onInitialStats: string;
    
    /**
     * URL картинки размером 32х32, которая будет размещена на кнопке "Сохранить 
     * правки и вернуться в CMS". Например логотип компании Партнёра.
     * 
     * @пример: "http://cms.my-company.ru/logo.png"
     * @обязательный: нет
     */
    returnIcon: boolean;
    
    /**
     * Подпись для кнопки "Сохранить правки и вернуться в CMS".
     * 
     * @пример: "Записать и вернуться в CMS"
     * @обязательный: нет
     */
    returnCaption: string;
    
    /**
     * URL картинки размером 32х32, которая будет размещена на кнопке "Отменить 
     * правки и вернуться в CMS".
     * 
     * @пример: "http://cms.my-company.ru/cancel-logo.png"
     * @обязательный: нет
     */
    cancelIcon: string;
    
    /**
     * Подпись для кнопки "Отменить правки и вернуться в CMS".
     *
     * @пример: "Отменить и вернуться в CMS"
     * @обязательный: нет
     */
    cancelCaption: string;
    
    /**
     * Тип логический (boolean), true или false, по умолчанию настройка включена. 
     * Если настройка включена, то в редакторе можно изменять размер встроенных 
     * картинок.
     * 
     * @пример: true
     * @обязательный: нет
     * @умолчание: true
     */
    allowResizeImages: boolean;
    
    /**
     * Тип логический (boolean), true или false, по умолчанию выключена. Если 
     * настройка включена, то в редакторе появляется кнопка "Отменить правки и 
     * вернуться в CMS", при нажатии на которую в CMS будет отправлен пустой 
     * запрос `on-save-corrected` (без указания параметра html). Это означает, 
     * что пользователь не хочет сохранять сделанные изменения.
     * 
     * @пример: false
     * @обязательный: нет
     * @умолчание: false
     */
    showCancelButton: boolean;
    
    /**
     * Полный путь до файла стилей для редактора. (исходники SCSS тем стилей, 
     * которые можно взять за основу можно найти на Githab 
     * https://github.com/orfogrammatika/litera5-api-css-themes)
     * 
     * @пример: "http://cms.my-company.ru/editor.css"
     * @обязательный: нет
     */
    editorCss: string;
    
    /**
     * Тип логический (boolean), true или false, по умолчанию настройка выключена. 
     * Если настройка включена, то в модели результата для onSaveCorrected вместе 
     * с обработанным текстом будет модель статистического отчёта в формате JSON.
     * 
     * @пример: false
     * @обязательный: нет
     * @умолчание: false
     */
    getStats: boolean;
    
    /**
     * Тип логический (boolean), true или false, по умолчанию выключена. Если 
     * настройка включена, то в редакторе при работе через API тулбар будет пустым.
     * 
     * @пример: false
     * @обязательный: нет
     * @умолчание: false
     */
    hideEditorToolbar: boolean;
    
    /**
     * Электронная подпись запроса, формируется по алгоритму `md5(time + company + 
     * onSaveCorrected + onIFrameFailure + onInitialStats + returnIcon + returnCaption 
     * + cancelIcon + cancelCaption + allowResizeImages + showCancelButton + editorCss 
     * + getStats + hideEditorToolbar + API_SECRET_KEY )`. Если какие-то поля отсутствуют 
     * в запросе, то при вычислении подписи они заменяются пустой строкой.
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}

Ответ

interface SetupResponse {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Электронная подпись запроса, формируется по алгоритму `md5(time + API_SECRET_KEY)`.
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}