.. _Integration_CryptoApi_EncryptingData:

Шифрование данных
#################

| Запрос: ``POST /v2/encrypt``
| HTTP-заголовки:

.. code-block::

    Authorization: Bearer access_token
    Content-Type: application/json
    Accept: application/json

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

.. code-block:: JSON

    {
        "Thumbprint": "string",         // отпечаток сертификата
        "CertificateRawData": "base64", // данные сертификата в виде массива байт в Base64
        "ThrowOnErrors": true,          // признак того, что в случае ошибки нужно прервать выполнение запроса
        "Contents": [                   // коллекция данных для шифрования
            "base64"
        ]
    }

Описание запроса
****************

Запрос позволяет зашифровать переданные данные с помощью открытого ключа заданного сертификата.

Сертификат для шифрования либо задается отпечатком в поле ``Thumbprint``, либо в поле ``CertificateRawData`` передается массив байт сертификата в Base64.

Запрос позволяет зашифровать несколько элементов данных за один раз. Данные для шифрования передаются в коллекции ``Contents``.
Каждый элемент коллекции - это массив байт в Base64.

Поле ``ThrowOnErrors`` управляет поведением запроса в случае, если возникли ошибки при шифровании одного из элементов коллекции.

Если поле установлено в ``true``, и хотя бы один из элементов коллекции не был зашифрован, то выполнение запроса прерывается
и возвращается :ref:`HTTP-статус 400 (Bad Request) <Integration_Common_ApiHttpStatuses_BadRequest>` с сообщением об ошибке.

Если поле установлено в ``false``, то выполнение запроса не прерывается и Crypto API пытается зашифровать оставшиеся элементы коллекции.

Ответ на запрос
***************

В случае успешного выполнения либо в случае значения ``false`` в поле ``ThrowOnErrors``, ответ на запрос содержит коллекцию результатов шифрования данных.

Порядок элементов в коллекции совпадает с порядком элементов в поле ``Contents`` запроса: первому элементу в ``Contents`` соответствует первый элемент в ответе.

Структура данных элемента коллекции представляет JSON вида:

.. code-block:: JSON

    {
        "Result": "base64",         // зашифрованные данные в виде массива байт в Base64
        "ErrorMessage": "string"    // сообщение об ошибке при шифровании данных
    }

Если данные были успешно зашифрованы, то они возвращаются в поле ``Result`` в виде массива байт в Base64.

Если данные не были зашифрованы, то в поле ``ErrorMessage`` возвращается текст возникшей ошибки.