Команда startView - Документация для КриптоАРМ 6
Перейти к содержанию

Команда startView#


Общая информация#

Команда startView используется для открытия конкретного окна приложения КриптоАРМ.

Схема взаимодействия:

Схема

Все запросы между КриптоАРМ и сервером ДОЛЖНЫ соответствовать спецификации протокола JSON-RPC 2.0.

В качестве транспорта используется HTTP.

🔍 Общее описание указано в разделе Формат ссылки.


Формат ссылки#

Для выполнения команды startView должна быть сформирована ссылка вида:

cryptoarm://startView/<URL>/?id=<id>
  • cryptoarm:// - зарегистрированный протокол
  • startView - выполняемая команда
  • <URL> - ссылка на получение JSON с параметрами, нужными для выполнения команды
  • id - уникальный идентификатор транзакции

Пример:

cryptoarm://startView/https://example.com/json?id=2c48eb32-a0a8-405c-ade9-eed130605cba

Получение параметров операции#

После получения команды startView КриптоАРМ отправляет запрос на получение параметров операции.

Формат запроса#

Ключ Значение Описание
jsonrpc «2.0» Версия JSON-RPC протокола. Всегда «2.0».
method startView.parameters Используемый метод. Всегда startView.parameters.
id Уникальный идентификатор Используется идентификатор, который указан в ссылке на операцию.
🔍 Формат ссылки
diagnostic IDiagnosticInformaton Диагностическая информация о рабочем месте

Пример:

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "startView.parameters",
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
    "diagnostic": {
    }
}

Формат ответа#

Ключ Значение Описание
jsonrpc «2.0» Версия JSON-RPC протокола. Всегда «2.0».
result IStartViewParameters Объект со сведениями о параметрах операции
id Уникальный идентификатор Используется идентификатор, который указан в ссылке на операцию.
🔍 Формат ссылки

Пример:

HTTP/1.1 200 OK
Connection: close
Content-Length: ...
Content-Type: application/json
Date: Sat, 08 Jul 2020 12:04:08 GMT
{
    "jsonrpc": "2.0",
    "result": {
        " uiView": CERTIFICATES_MY,
        "props": {
            "headerText": "ИС cryptoarm.ru",
            "descriptionText": "Запрос на открытие окна"
        }
    },
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba"
}

Интерфейс 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 символов.

Для повышения удобства работы и хранения данных веб-сайт CRYPTOARM.RU использует файлы COOKIE. Продолжая работу с веб-сайтом, Вы даете свое согласие на работу с этими файлами.