Аутентификация в API Yandex Cloud Postbox
Статья создана
Обновлена 23 сентября 2024 г.
Вы можете работать с Yandex Cloud Postbox с помощью API Amazon. Для аутентификации в нем используйте статический ключ доступа или IAM-токен. Все операции выполняются от имени сервисного аккаунта, которому выдан статический ключ или IAM-токен. Подробнее описано в разделе Как пользоваться API.
Чтобы использовать API Amazon напрямую, без AWS CLI и приложений, воспользуйтесь одним из способов:
- Самостоятельно составьте подпись запроса, она передается в заголовке
Authorization
. О том, как подписать запрос и проверить подпись, читайте в разделе Подписывание запросов. - Аутентифицируйтесь через IAM-токен: получите его для сервисного аккаунта и передайте в заголовке
X-YaCloud-SubjectToken
. В этом случае заголовокAuthorization
и подпись не нужны.
Примеры использования API Amazon
В примерах приводится запрос для получения списка конфигураций. Запрос отправляется через утилиту cURL
Перед началом работы создайте сервисный аккаунт с подходящей вам ролью. Для этих примеров подойдет роль postbox.viewer
.
Аутентификация с помощью статического ключа
-
Создайте статический ключ для сервисного аккаунта.
-
Выполните запрос:
export AWS_KEY_ID="<идентификатор_статического_ключа>" && \ export AWS_SECRET_KEY="<секретный_ключ>" && \ curl \ --request GET \ --user "${AWS_KEY_ID}:${AWS_SECRET_KEY}" \ --aws-sigv4 "aws:amz:ru-central1:ses" \ --url 'https://postbox.cloud.yandex.net/v2/email/configuration-sets' \ --verbose
Аутентификация с помощью IAM-токена
-
Получите IAM-токен для сервисного аккаунта.
-
Выполните запрос:
export IAM_TOKEN="<IAM-токен>" && \ curl \ --request GET \ --header "X-YaCloud-SubjectToken: ${IAM_TOKEN}" \ --url 'https://postbox.cloud.yandex.net/v2/email/configuration-sets' \ --verbose