api l5 check ogxt

POST check-ogxt

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

Метод для запуска проверки текста без участия пользователя и без использования редактора Литеры.

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

Запрос

interface CheckOgxtRequest {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Идентификатор Партнёра, указанный при регистрации в Литере.
     * 
     * @пример: "my-company"
     * @обязательный: да
     */
    company: string;
    
    /**
     * Логин пользователя Литеры, который работает с документом.
     * 
     * @пример: "user"
     * @обязательный: да 
     */
    login: string;
    
    /**
     * Тип проверки документа (закладка «правописание» (ortho), «красота» (cicero) 
     * или «качество» (quality)). В зависимости от типа проверки подключаются 
     * различные наборы правил на которые проверяется текст.
     * 
     * @пример: "ortho"
     * @обязательный: нет
     * @умолчание: "ortho"
     */
    profile: string;
    
    /**
     * Идентификатор документа в системе Сайта. Если указан, то будет продолжена 
     * работа над тем же самым документом, если нет, то будет создан новый документ. 
     * Пожалуйста, обратите внимание на то обстоятельство, что в данный момент в 
     * Литере5 с документом может работать только один пользователь. Поэтому 
     * несмотря на то, что в CMS с документом могут работать различные пользователи, 
     * при работе с одним и тем же документом в API имеет смысл передавать в `login` 
     * не идентификатор текущего пользователя CMS Партнёра, а идентификатор 
     * пользователя создавшего данный документ в Литере5 (того пользователя в 
     * результате проверки которого был выдан этот `document`). В противном случае 
     * API выдаст ошибку о недостатке прав пользователя на работу с документом.
     * 
     * @пример: "539557f78dfdedee48e136f8"
     * @обязательный: нет
     */
    document: string;
    
    /**
     * Название документа (title, subject). Если не указано, то будет сформировано 
     * автоматически из текста.
     * 
     * @пример: "Название документа"
     * @обязательный: нет
     */
    name: string;
    
    /**
     * Оригинальные текст для проверки в формате html. Если указан `document`, то 
     * текст заместит собой текст выбранного `document`. Этот текст используется 
     * для отображения проверок в интерфейсе Литеры.
     * 
     * @пример: "<h1>Загаловак</h1><p>текст с ашипками</p>"
     * @обязательный: да 
     */
    html: string;
    
    /**
     * Текст для проверки в формате ogxt полученный из текста html, например при 
     * помощи утилит ogxt-utils (https://github.com/orfogrammatika/ogxt-utils).
     * 
     * @пример: "Загаловак
     * текст с ашипками
     * ----------------------------------
     * [{header: }]"
     * @обязательный: да 
     */
    ogxt: string;
     
    /**
     * Электронная подпись запроса, формируется по алгоритму `md5(time + company 
     * + login + profile + document + name + html + ogxt + API_SECRET_KEY)`.
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}

Ответ

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