api l5 check ogxt results

POST check-ogxt-results

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

Проверяет текущее состояние проверки и получает результаты в случае её окончания.

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

Запрос

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

Ответ

interface CheckOgxtResultsResponse {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Текущее состояние проверки. Все возможные значения можно разделить на 
     * три группы: 
     * - Проверка благополучно завершена: 
     *   + CHECKED_SUCCESS 
     * - Проверка не удалась:
     *   + ESTIMATED_ERROR
     *   + ESTIMATED_REJECT
     *   + CANCELLED
     *   + REJECTED
     *   + CHECKED_ERROR
     * - Проверка ещё не закончилась: 
     *   + CREATED
     *   + UPLOADED
     *   + WAITING_ESTIMATION
     *   + ESTIMATING
     *   + ESTIMATED_SUCCESS
     *   + WAITING_CHECK
     *   + CHECKING
     * 
     * @пример: "CHECKED_SUCCESS"
     * @обязательный: да
     */
    state: string;
    
    /**
     * Прогресс проверки в целых процентах (число)
     * 
     * @пример: 100
     * @обязательный: да 
     */
    progress: number;
    
    /**
     * Дополнительное текстовое сообщение разъясняющее текущее состояние 
     * (в случае ошибочных состояний здесь будет поясняющее объяснение 
     * сложившейся ситуации)
     * 
     * @пример: "Проверка завершена"
     * @обязательный: да
     */
    message: string;
    
    /**
     * HTML который был подвергнут проверке в который можно встраивать 
     * результаты (на случай, если текст уже изменился)
     * 
     * @пример: "<h1>Загаловак<h1><p>текст с ашипками</p>"
     * @обязательный: нет
     */
    html: string;
    
    /**
     * JSON модель результатов проверки.
     * 
     * @обязательный: нет
     */
    annotations: object;
    
    /**
     * JSON модель статистического отчёта.
     * 
     * @обязательный: нет
     */
    stats: object;
    
    /**
     * Электронная подпись ответа, формируется по алгоритму `md5(time + 
     * state + progress + message + html + API_SECRET_KEY)`
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}

Модели результатов проверки и статистического отчёта описаны отдельно на страницах annotations и stats соответственно.