Команда startView — описание и примеры

Команда startView открывает выбранное окно приложения КриптоАРМ и передает ему необходимые параметры.

Содержание:

• Команда startView — описание и примеры
• Общая информация
• Формат ссылки
• Получение параметров операции
  • Формат запроса
  • Формат ответа
• Справочник интерфейсов
  • Интерфейс IStartViewParameters
  • Интерфейс IStartViewOperationProps

---

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

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

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

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

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

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

---

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

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

cryptoarm://startView/<URL>/?id=<id>[&authType=<authType>]

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

Пример:

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	IDiagnosticsInformation	Диагностическая информация о рабочем месте. Содержит поля VERSIONS, PROVIDERS, LICENSES.

Пример:

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "startView.parameters",
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
    "diagnostic": {
      "VERSIONS": {
        "csp": "5.0.11753",
        "cryptoarm": "2.5.2",
        "openssl": "1.1.1w"
      },
      "PROVIDERS": {
        "GOST2012_256": true,
        "GOST2012_512": true,
        "openssl": true
      },
      "LICENSES": {
        "csp": { "status": true, "type": "", "expiration": "" },
        "cryptoarm": { "status": true, "type": "Permanent", "expiration": "" }
      }
    }
}

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

Ключ	Значение	Описание
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 — окно подписи и шифрования, VERIFY_AND_DECRYPT — окно проверки и расшифрования, CERTIFICATES_MY — Сертификаты / Личные, CERTIFICATES_ADDRESS_BOOK — Сертификаты / Другие пользователи, CERTIFICATES_CA — Сертификаты / Промежуточные, CERTIFICATES_ROOT — Сертификаты / Корневые, CONTACTS — окно Контакты, KEYS — Сертификаты / Ключевые контейнеры, ABOUT и DIAGNOSTICS — окно Настройки (О программе), DIAGNOSTIC_PROBLEM_PERSONAL_CERTIFICATES — диагностика проблем личных сертификатов (в разработке).
props	IStartViewOperationProps	Параметры операции

Интерфейс IStartViewOperationProps

Интерфейс IStartViewOperationProps описывает параметры операции.

Свойство	Тип	Описание
headerText?	string	Необязательный параметр. Используется для отображения в заголовке окна. Максимальная длина - 40 символов.
descriptionText?	string	Необязательный параметр. Используется для отображения в сведениях об операции. Максимальная длина - 120 символов.

Предыдущая

Следующая