api cms on initial stats

POST on-initial-stats

• Метод: POST
• URL: https://cms.my-company.ru/litera/on-initial-stats/
• Content-type: application/json

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

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

Запрос

interface OnInitialStatsRequest {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Идентификатор переданный в ходе запроса CheckRequest.token.
     * 
     * @пример: "любаяСтрока"
     * @обязательный: да
     */
    token: string;
    
    /**
     * Сообщение о произошедшей ошибке. Одно из полей error или stats будет 
     * заполнено обязательно. И они не могут быть заполнены одновременно. 
     * Наличие сообщения об ошибке означает, что документ не смог провериться 
     * из-за проблем в Литере.
     * 
     * @пример: "Что-то пошло не так, проверка поломалась"
     * @обязательный: нет
     */
    error: string;
    
    /**
     * JSON модель статистического отчёта.
     * 
     * @пример: {"annotations": [], "words": []}
     * @обязательный: нет
     */
    stats: object;
    
   
    /**
     * Электронная подпись запроса, формируется по алгоритму `md5(time + token + 
     * error + API_SECRET_KEY)`
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}

Модель статистического отчёта описана отдельно на странице stats.

Ответ

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