API для работы с функционалом электронного подписания

Выгрузка документов

С целью более удобной работы с документами, которые участвуют в подписании, был реализован новый метод API для выгрузки документов:

domain/mods/DigitalSignatureAPIFacade/GetSignatures?id_ComplexReserve=XXXXXX

где XXXXXX – номер командировки, а domain – адрес сайта.

Для отправки запроса используется базовая авторизация. Значение параметра авторизации может быть получено путем перевода связки логин:пароль в формат base64.

Например, в Postman заголовок будет выглядеть следующим образом

Обращение к методу возвращает в ответе все данные по документам и персонам по имеющимся процессам подписания.
Пример ответа:

{
    "result": [
        {
            "id": 2318,
            "scenarioId": 25,
            "scenarioName": "Документы для выезда в командировку",
            "travellerState": "signed",
            "travellerEmail": "alenasrg83@mail.ru",
            "signerState": "signed",
            "signerEmail": "usr8388@corteos.travel",
            "url": "https://static3.corteos.ru/DigiSign/2025-02/813496/ae400be2-0852-4864-b2ea-54ebde194bac/moddigisign/prikaz.pdf?t=638745416936831459",
            "outerState": "123",
            "documentName": "Приказ",
            "id_Person": 947103,
            "created": "ЭЦП"
        }
    ],
    "info": {
        "sessionId": "1A2287Y30JR0I",
        "timing": {
            "start": "2025-02-12T19:55:16.0711385+03:00",
            "end": "2025-02-12T19:55:16.0833088+03:00",
            "duration": 12.170300000000001
        }
    },
    "errors": [],
    "hasErrors": false

Где:

"id" – уникальный идентификатор подписываемого документа
"scenarioId" – уникальный идентификатор сценария подписания
"scenarioName" – название сценария
"travellerState" – статус подписания командируемым
"travellerEmail" – логин командируемого
"signerState" – статус подписания руководителем
"signerEmail" – логин руководителя
"url" – ссылка на скачивание подписываемого документа
"outerState" – признак получения документа внешней системой
"documentName" – название подписываемого документа
id_Person" – ИД Кортеос персоны командируемого (traveller)
"Created" – состояние документа возможные значения:
- Системой (если возвращается шаблон без ЭЦП)
- Вручную (если возвращается вручную загруженный файл, но не подписанный ЭЦП)
- ЭЦП (если возвращается файл, подписанный ЭЦП всеми участниками)

Проставление признака получения документа внешней системой

Также был реализован метод, позволяющий присвоить документу признак получения внешней системой (может быть использован с целью блокирования отзыва подписания по сценарию и пассажиру, к которым относится этот документ):

domain/mods/DigitalSignatureAPIFacade/SetOuterState

Где:

domain – адрес сайта

Для отправки запроса используется базовая авторизация. Значение параметра авторизации может быть получено путем перевода связки логин:пароль в формат base64.

В теле запроса необходимо передать уникальный идентификатор подписываемого документа, полученный в ответ на запрос (см. выше):

domain/mods/DigitalSignatureAPIFacade/GetSignatures?id_ComplexReserve=XXXXXX

Тело запроса:

{
    id: 1465,
    state: "123"
}

Пример ответа:

{
    "result": {
        "id": 2318,
        "scenarioId": 25,
        "scenarioName": "Документы для выезда в командировку",
        "travellerState": "signed",
        "travellerEmail": "alenasrg83@mail.ru",
        "signerState": "signed",
        "signerEmail": "usr8388@corteos.travel",
        "url": "https://static3.corteos.ru/DigiSign/2025-02/813496/ae400be2-0852-4864-b2ea-54ebde194bac/moddigisign/prikaz.pdf?t=638745416936831459",
        "outerState": "123",
        "documentName": "Приказ",
        "id_Person": 947103,
        "created": "ЭЦП"
    },
    "info": {
        "sessionId": "1A2287ZXRQT1C",
        "timing": {
            "start": "2025-02-12T20:01:59.6901183+03:00",
            "end": "2025-02-12T20:01:59.7471727+03:00",
            "duration": 57.0544
        }
    },
    "errors": [],
    "hasErrors": false
}