api cms on iframe failure

POST on-iframe-failure

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

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

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

Запрос

interface IFrameFailureRequest {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Идентификатор переданный в ходе запроса CheckRequest.token.
     * 
     * @пример: "любаяСтрока"
     * @обязательный: да
     */
    token: string;
    
    /**
     * Урл при обработке которого произошла ошибка
     * 
     * @пример: "https://litera5.ru/api/pub/iframe/52fb432f8dfd8b7b0d9a8ff2/"
     * @обязательный: да
     */
    url: string;
    
    /**
     * Код ошибки произошедшей при обработке одноразовой ссылки редактора Литеры
     * 
     * @пример: 404
     * @обязательный: да
     */
    code: number;
    
    /**
     * В случае, если при обработке одноразовой ссылки произошла какая-то ошибка,  
     * Пользователю  будет показано соответствующее сообщение об ошибке с 
     * кнопкой-предложением  "Вернуться в CMS" . Это же сообщение передаётся на 
     * сервер сайта партнёра при помощи этого метода.
     * 
     * @пример: "Не найдена одноразовая ссылка на проверку"
     * @обязательный: да
     */
    message: string;
   
    /**
     * Электронная подпись запроса, формируется по алгоритму `md5(time + token + 
     * url + code + message + API_SECRET_KEY)`
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}

Ответ

interface IFrameFailureResponse {
    /**
     * Текущее время в формате unix timestamp (количество секунд с 1970 года)
     * 
     * @пример: "1410103972"
     * @обязательный: да
     */
    time: string;
    
    /**
     * Ссылка на страницу сайта Партнёра на которую будет перенаправлен 
     * ответ в редакторе Литеры при помощи HTTP 302 редиректа.
     * 
     * @пример: "http://cms.my-company.ru/litera/return-to-cms?user=12&doc=12345"
     * @обязательный: да
     */
    url: string;
    
    /**
     * Электронная подпись ответа, формируется по алгоритму `md5(time + 
     * url + API_SECRET_KEY)`
     * 
     * @пример: "5eb63bbbe01eeed093cb22bb8f5acdc3"
     * @обязательный: да
     */
    signature: string;
}