Выполнение типовых задач

Створення ЕП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Должен быть указан параметр "caId".
4	Завантажити ключовий контейнер сесії
5	Создать ЭП
6	Получить данные ЭП	Блокирующая (синхронная) операция.
7	Видалити сесію

Пример создания ЭП для текстовых данных (Java, Maven, Cipher Signer Server): https://github.com/stokipny/sjwsa-singer-server-client

Создание ЭП с контролем состояния

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

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Должен быть указан параметр "caId".
4	Завантажити ключовий контейнер сесії
5	Создать ЭП
6	Получить результат создания ЭП	Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса создания ЭП.
7	Получить данные ЭП	Блокирующая (синхронная) операция.
8	Видалити сесію

Создание множественной встроенной ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Загрузить данные ЭП	В качестве данных ЭП должна быть загружена ранее созданная встроенная ЭП. Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Должен быть указан параметр "caId". Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned". Для параметра "signatureType" должно быть установлено значение "attached". Для параметр "duplicateSign" должно быть установлено значение "true", если необходимо обеспечить возможность подписания документа несколько раз одним и тем же подписантом.
4	Завантажити ключовий контейнер сесії
5	Создать ЭП
6	Получить данные ЭП	Блокирующая (синхронная) операция.
7	Видалити сесію

Создание множественной открепленной ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными
3	Загрузить данные ЭП	В качестве данных ЭП должна быть загружена ранее созданная для данных сессии открепленная ЭП. Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
4	Встановити параметри сесії	Должен быть указан параметр "caId". Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned". Для параметра "signatureType" должно быть установлено значение "detached". Для параметр "duplicateSign" должно быть установлено значение "true", если необходимо обеспечить возможность подписания документа несколько раз одним и тем же подписантом.
5	Завантажити ключовий контейнер сесії
6	Создать ЭП
7	Получить данные ЭП	Блокирующая (синхронная) операция.
8	Видалити сесію

Создание мобильной ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Поддерживаемые параметры: "signatureType", "cadesType".
4	Получить список поддерживаемых ПУМЭП	По результату выполнения запроса выбрать ПУМЭП и использовать его идентификатор на этапах 5-6.
5	Получить список профилей владельца ключей	По результату выполнения запроса выбрать профиль владельца ключа и использовать его на этапе 6.
6	Создать мобильную ЭП
7	Получить данные мобильной ЭП	Блокирующая (синхронная) операция.
8	Видалити сесію

Создание мобильной ЭП с контролем состояния

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Поддерживаемые параметры: "signatureType", "cadesType".
4	Получить список поддерживаемых ПУМЭП	По результату выполнения запроса выбрать ПУМЭП и использовать его идентификатор на этапах 5-8.
5	Получить список профилей владельца ключей	По результату выполнения запроса выбрать профиль владельца ключа и использовать его на этапе 6.
6	Создать мобильную ЭП
7	Получить результат создания мобильной ЭП	Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса создания мобильной ЭП.
8	Получить данные мобильной ЭП	Блокирующая (синхронная) операция.
9	Видалити сесію

Создание множественной встроенной мобильной ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Загрузить данные ЭП	В качестве данных ЭП должна быть загружена ранее созданная встроенная ЭП. Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії	Поддерживаемые параметры: "signatureType", "cadesType", "dataToSignQualifier". Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned".
4	Получить список поддерживаемых ПУМЭП	По результату выполнения запроса выбрать ПУМЭП и использовать его идентификатор на этапах 5-6.
5	Получить список профилей владельца ключей	По результату выполнения запроса выбрать профиль владельца ключа и использовать его на этапе 6.
6	Создать мобильную ЭП
7	Получить данные мобильной ЭП	Блокирующая (синхронная) операция.
8	Видалити сесію

Создание множественной открепленной мобильной ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными
3	Загрузить данные ЭП	В качестве данных ЭП должна быть загружена ранее созданная для данных сессии открепленная ЭП. Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
4	Встановити параметри сесії	Поддерживаемые параметры: "signatureType", "cadesType", "dataToSignQualifier". Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned".
5	Получить список поддерживаемых ПУМЭП	По результату выполнения запроса выбрать ПУМЭП и использовать его идентификатор на этапах 6-7.
6	Получить список профилей владельца ключей	По результату выполнения запроса выбрать профиль владельца ключа и использовать его на этапе 7.
7	Создать мобильную ЭП
8	Получить данные мобильной ЭП	Блокирующая (синхронная) операция.
9	Видалити сесію

Создание ЭП с ключами из Шифр-HSM-Site

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
3	Встановити параметри сесії
4	Завантажити ключовий контейнер сесії	В параметре keyStoreUri должен быть указан URI токена. Тестовый токен: URI: cihsm://cipher-test-site/vhsm-53.2059a40a Password: 12345678
5	Создать ЭП
6	Получить данные ЭП	Блокирующая (синхронная) операция.
7	Видалити сесію

Создание ЭП с ключами Depositsign

	Назва операції	Примітка
1	Получить токен доступа к API Depositsign и идентификатор хранилища ключей	Выполнить метод API Depositsign: /api/v1/{clientId}/auth/login Тестовая учетная запись: UserName: testDS Password: testDS Документация по API Depositsign: https://depositsign.com/swagger-api-doc
2	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
3	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
4	Встановити параметри сесії
5	Завантажити ключовий контейнер сесії	В параметре keyStoreUri должен быть указан URI хранилища ключей (токена), получаем значение "KeyName" с первого запроса "Получить токен доступа к API Depositsign и идентификатор хранилища ключей". В параметре bearerToken должен быть указан токен доступа к API Depositsign.
6	Создать ЭП
7	Получить данные ЭП	Блокирующая (синхронная) операция.
8	Видалити сесію

Проверка ЭП

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными
3	Загрузить данные ЭП	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными
4	Встановити параметри сесії
5	Проверить ЭП
6	Получить результат проверки ЭП	Блокирующая (синхронная) операция.
7	Видалити сесію

Если после проверки прикрепленной ЭП необходимо получить (извлечь) подписанные данные, то следует использовать запрос Получение подписанных данных.

Пример проверки ЭП с извлечением для текстовых данных (Java, Maven, Cipher Signer Server): https://github.com/stokipny/sjwsa-singer-server-client

Зашифровывание

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "caId", "embedCertificateType".
4	Завантажити ключовий контейнер сесії
5	Загрузить сертификаты получателей	Необходим как минимум один сертификат получателя зашифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки.
6	Зашифровать
7	Получить зашифрованные данные	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
8	Видалити сесію

Зашифровывание с контролем состояния

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

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "caId", "embedCertificateType".
4	Завантажити ключовий контейнер сесії
5	Загрузить сертификаты получателей	Необходим как минимум один сертификат получателя зашифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки.
6	Зашифровать
7	Получить результат зашифрования	Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса зашифрования.
8	Получить зашифрованные данные	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
9	Видалити сесію

Зашифрувати ключами з Шифр-HSM-Site

Можливе використання у випадку пакетної обробки великої кількості ресурсів (файлів).

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "embedCertificateType".
4	Завантажити ключовий контейнер сесії	В параметре keyStoreUri должен быть указан URI токена. Тестовый токен: URI: cihsm://cipher-test-site/vhsm-53.478d4f5b Password: 12345678
5	Завантажити сертифікати отримувачів	Необходим как минимум один сертификат получателя зашифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки.
6	Зашифрувати
7	Отримати зашифровані дані	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
8	Видалити сесію

Розшифрувати

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "caId".
4	Завантажити ключовий контейнер сесії
5	Розшифрувати
6	Отримати розшифровані дані	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
7	Видалити сесію

Розшифрувати з контролем стану

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "caId".
4	Завантажити ключовий контейнер сесії
5	Розшифрувати
6	Отримати результат розшифрування	Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса расшифрования.
7	Отримати розшифровані дані	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
8	Видалити сесію

Розшифрувати ключами з Шифр-HSM-Site

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки.
3	Встановити параметри сесії	Должен быть указан параметр "caId".
4	Завантажити ключовий контейнер сесії	В параметре keyStoreUri должен быть указан URI токена. Тестовый токен: URI: cihsm://cipher-test-site/vhsm-53.478d4f5b Password: 12345678
5	Розшифрувати
6	Отримати розшифровані дані	Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
7	Видалити сесію

Створення електронної позначки часу

	Назва операції	Примітка
1	Створити сесію	Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.
2	Завантажити дані сесії	Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными
3	Встановити параметри сесії	Пункты 3 и 4 могут выполняться в произвольном порядке.
4	Створити ЕПЧ
5	Отримати дані ЕПЧ	Блокирующая (синхронная) операция.
6	Видалити сесію

Створення електронної позначки часу з контролем стану