Заголовки запросов

Заголовок

Описание

Accept

Тип данных в ответе. Например, application/json (значение по умолчанию).

Подробнее про типы данных читайте в статье Список MIME-типов на Википедии.

Authorization

Любой запрос к Yandex Cloud Postbox должен быть авторизован.

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

Чтобы не подписывать запрос, используйте для аутентификации заголовок X-YaCloud-SubjectToken вместо заголовка Authorization.

Content-Type

Тип данных в запросе. Например, application/json (значение по умолчанию).

Подробнее про типы данных читайте в статье Список MIME-типов на Википедии.

X-Amz-Algorithm

Алгоритм для подписи запроса.

Передавайте в заголовке значение AWS4-HMAC-SHA256, так как Yandex Cloud Postbox поддерживает подпись Amazon Signature Version 4.

X-Amz-Content-Sha256

Хеш полезной нагрузки запроса. Применяется для подписи запроса в формате Amazon Signature Version 4.

X-Amz-Credential

Область, в которой подпись валидна. Формат заголовка: <идентификатор_статического_ключа>/<дата>/ru-central1/ses/aws4_request. В заголовке укажите:

• идентификатор статического ключа доступа, полученный во время подготовки к работе;
• дату в формате YYYYMMDD.

X-Amz-Date

Время в формате ISO 8601. Пример: 20240920T091646Z.

X-Amz-Security-Token

Токен, который передается, если данные для аутентификации выпустил STS-сервис.

X-Amz-Signature

Подпись запроса. Подробнее о подписывании запросов.

X-Amz-SignedHeaders

Список заголовков, которые использовались для составления подписи запроса. Необходимые заголовки:

• host — HTTP-хост, куда отправляются запросы.
• x-amz-* — заголовки API Amazon.

Укажите заголовки в нижнем регистре, отсортируйте их по алфавиту и разделите точками с запятыми. Пример: host;x-amz-date.

X-YaCloud-SubjectToken

IAM-токен для аутентификации в API.

Используйте только один из двух заголовков: Authorization или X-YaCloud-SubjectToken. Для Authorization нужно получить статический ключ доступа и подписать запрос, для X-YaCloud-SubjectToken — получить IAM-токен. Подробнее об аутентификации.