Команда startView#
- Общая информация
- Формат ссылки
- Получение параметров операции
- Интерфейс IStartViewParameters
- Интерфейс IStartViewOperationProps
Общая информация#
Команда startView
используется для открытия конкретного окна приложения КриптоАРМ.
Схема взаимодействия:
Все запросы между КриптоАРМ и сервером ДОЛЖНЫ соответствовать спецификации протокола JSON-RPC 2.0.
В качестве транспорта используется HTTP.
🔍 Общее описание указано в разделе Формат ссылки.
Формат ссылки#
Для выполнения команды startView
должна быть сформирована ссылка вида:
cryptoarm://
- зарегистрированный протоколstartView
- выполняемая команда<URL>
- ссылка на получение JSON с параметрами, нужными для выполнения командыid
- уникальный идентификатор транзакции
Пример:
Получение параметров операции#
После получения команды startView
КриптоАРМ отправляет запрос на получение параметров операции.
Формат запроса#
Ключ | Значение | Описание |
---|---|---|
jsonrpc | «2.0» | Версия JSON-RPC протокола. Всегда «2.0». |
method | startView.parameters | Используемый метод. Всегда startView.parameters . |
id | Уникальный идентификатор | Используется идентификатор, который указан в ссылке на операцию. 🔍 Формат ссылки |
diagnostic | IDiagnosticInformaton | Диагностическая информация о рабочем месте |
Пример:
Формат ответа#
Ключ | Значение | Описание |
---|---|---|
jsonrpc | «2.0» | Версия JSON-RPC протокола. Всегда «2.0». |
result | IStartViewParameters | Объект со сведениями о параметрах операции |
id | Уникальный идентификатор | Используется идентификатор, который указан в ссылке на операцию. 🔍 Формат ссылки |
Пример:
Интерфейс IStartViewParameters#
Объекты данного типа описывают вид операции и её параметры.
Ключ | Значение | Описание |
---|---|---|
uiView | string | Тип окна, которое нужно отобразить пользователю. Доступные значения: - “MAIL” – окно почты, - “DOCUMENTS” – окно Документы, - “SIGN_AND_ENCRYPT” - окно подписи и шифрования, - “CERTIFICATES_MY” - окно Сертификаты/Личные сертификаты, - “CERTIFICATES_ADDRESS_BOOK” - окно Сертификаты/Другие пользователи, - “CERTIFICATES_CA” - окно Сертификаты/Промежуточные, - “CERTIFICATES_ROOT” - окно Сертификаты/Корневые, - “CONTACTS” - окно Контакты, - “KEYS” - окно Сертификаты/Список контейнеров, - “ABOUT” и “DIAGNOSTIC” - окно О программе (Настройки). |
props | IStartViewOperationProps | Параметры операции |
Интерфейс IStartViewOperationProps#
Интерфейс IStartViewOperationProps
описывает параметры операции.
Свойство | Тип | Описание |
---|---|---|
headerText? | string | Необязательный параметр. Используется для отображения в заголовке окна. Максимальная длина - 40 символов. |
descriptionText? | string | Необязательный параметр. Используется для отображения в сведениях об операции. Максимальная длина - 120 символов. |