Обзор HTTP API Yandex Cloud Notification Service
HTTP API сервиса Cloud Notification Service совместим с Amazon SNS API.
Для более удобного взаимодействия с сервисом поддержана работа с AWS CLI и AWS SDK для Python (boto3).
Для аутентификации в API, CLI и SDK используется статический ключ доступа. Статический ключ доступа выпускается на сервисный аккаунт, и все действия выполняются от имени этого сервисного аккаунта.
Примечание
Запросы API к Cloud Notification Service со статическим ключом должны быть подписаны по алгоритму AWS Signature V4.
Чтобы не подписывать запросы API к Cloud Notification Service, вместо статического ключа вы можете использовать IAM-токен. Подробнее см. Отправить запрос HTTP API к Yandex Cloud Notification Service.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.
Поддерживаемые действия
PlatformApplications
| Действие | Описание |
|---|---|
| Create | Создать канал мобильных push-уведомлений. |
| GetAttributes | Получить параметры канала мобильных push-уведомлений. |
| SetAttributes | Задать параметры канала мобильных push-уведомлений. |
| List | Получить список каналов мобильных push-уведомлений. |
| Delete | Удалить канал мобильных push-уведомлений. |
Endpoint
| Действие | Описание |
|---|---|
| Create | Создать эндпоинт для push-уведомлений (подписать пользователя на push-уведомления). |
| GetAttributes | Получить параметры эндпоинта. |
| SetAttributes | Задать параметры эндпоинта. |
| List | Получить список эндпоинтов. |
| Delete | Удалить эндпоинт (отписать пользователя от push-уведомлений). |
Publish
| Действие | Описание |
|---|---|
| Publish | Отправить push-уведомление. |