Связаться с намиПодключиться

Отправить запрос HTTP API к Yandex Cloud Notification Service

Статья создана
Обновлена 13 марта 2025 г.

HTTP API сервиса совместим с Amazon SNS API.

Все поддерживаемые действия описаны в Справочнике API.

Чтобы начать работу с HTTP API с помощью curl:

  1. Подготовьте облако к работе.
  2. Получите данные для аутентификации.
  3. Создайте канал уведомлений.
  4. Получите список каналов.
  5. Создайте эндпоинт.
  6. Отправьте уведомление.

Подготовьте облако к работе

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

  1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
  2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Получите данные для аутентификации

Для аутентификации в API используются статический ключ доступа или IAM-токен.

Примечание

Запросы API к Cloud Notification Service со статическим ключом должны быть подписаны по алгоритму AWS Signature V4. Чтобы не подписывать запросы, используйте IAM-токен.

Как получить IAM-токен, см. в инструкциях:

Как получить статический ключ доступа

Для аутентификации в Cloud Notification Service используется статический ключ доступа. Этот ключ выпускается на сервисный аккаунт, и все действия выполняются от имени этого сервисного аккаунта.

Чтобы получить статический ключ доступа:

  1. Создайте сервисный аккаунт.

  2. Назначьте сервисному аккаунту роль editor на каталог.

  3. Для сервисного аккаунта создайте статический ключ доступа.

    Сохраните идентификатор и секретный ключ.

Чтобы выполнять запросы API, у пользователя или сервисного аккаунта должна быть минимальная роль editor на каталог.

Создайте канал уведомлений

export IAM_TOKEN=<IAM-токен>
curl \
  --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  --data-urlencode "Action=CreatePlatformApplication" \
  --data-urlencode "ResponseFormat=JSON" \
  --data-urlencode "FolderId=<идентификатор_каталога>" \
  --data-urlencode "Name=<имя_канала>" \
  --data-urlencode "Platform=GCM" \
  --data-urlencode "Attributes.entry.1.key=PlatformCredential" \
  --data-urlencode "Attributes.entry.1.value=<API-ключ_FCM>"
  "https://notifications.yandexcloud.net/"

Где:

  • IAM_TOKEN — IAM-токен.

  • Action — тип операции.

  • ResponseFormat — формат ответа: JSON или XML.

  • FolderId — идентификатор каталога.

  • Name — имя канала уведомлений, задается пользователем.

    Имя должно быть уникальным для всего CNS. После создания канала изменить имя нельзя. Имя может содержать строчные и заглавные буквы латинского алфавита, цифры, подчеркивания, дефисы и точки. Длина — от 1 до 256 символов. Рекомендуется для каналов APNs указывать в имени идентификатор приложения (Bundle ID), для FCM и HMS — полное название пакета приложения (Package name), для RuStore — значение packageName.

  • Platform — тип мобильной платформы:

    • APNS и APNS_SANDBOX — Apple Push Notification service (APNs). Для тестирования приложения используйте APNS_SANDBOX.
    • GCM — Firebase Cloud Messaging (FCM).
    • HMS — Huawei Mobile Services (HMS).
    • RUSTORE — RuStore Android.

  • Attributes.entry.N.key — ключи атрибутов аутентификации на мобильной платформе. Значения зависят от типа платформы:

    • APNs:

      • Аутентификация с токеном:
        • PlatformPrincipal — токен в формате .p8.
        • PlatformCredential — идентификатор токена.
        • ApplePlatformTeamID — идентификатор разработчика.
        • ApplePlatformBundleID — идентификатор приложения (Bundle ID).
      • Аутентификация с сертификатом:
        • PlatformPrincipal — SSL-сертификат в формате .p12.
        • PlatformCredential — закрытый ключ сертификата.

      Аутентификация с токеном является предпочтительной, как более современная.

    • FCM: PlatformCredential — ключ сервисного аккаунта Google Cloud в формате JSON для аутентификации с помощью HTTP v1 API или API-ключ (server key) для аутентификации с помощью Legacy API.

      Версия HTTP v1 API является предпочтительной, так как с июня 2024 года Legacy API не будет поддерживаться FCM.

    • HMS:

      • PlatformPrincipal — идентификатор ключа.
      • PlatformCredential — API-ключ.

    • RuStore:

      • PlatformPrincipal — идентификатор проекта (ProjectID).
      • PlatformCredential — сервисный токен (ServiceToken).

  • Attributes.entry.N.value — значения атрибутов аутентификации на мобильной платформе.

В результате вы получите идентификатор (ARN) канала уведомлений.

Подробнее см. на странице Действие CreatePlatformApplication.

Получите список каналов

export IAM_TOKEN=<IAM-токен>
curl \
  --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  --data-urlencode "Action=ListPlatformApplications" \
  --data-urlencode "ResponseFormat=JSON" \
  --data-urlencode "FolderId=<идентификатор_каталога>" \
  "https://notifications.yandexcloud.net/"

Где:

Подробнее см. на странице Действие ListPlatformApplications.

Создайте эндпоинт

export IAM_TOKEN=<IAM-токен>
curl \
  --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  --data-urlencode "Action=CreatePlatformEndpoint" \
  --data-urlencode "ResponseFormat=JSON" \
  --data-urlencode "PlatformApplicationArn=<ARN_канала_уведомлений>" \
  --data-urlencode "Token=<Push-токен>" \
  "https://notifications.yandexcloud.net/"

Где:

  • IAM_TOKEN — IAM-токен.
  • Action — тип операции.
  • ResponseFormat — формат ответа: JSON или XML.
  • PlatformApplicationArn — идентификатор (ARN) канала уведомлений.
  • Token — уникальный Push-токен приложения на устройстве пользователя.

В результате вы получите идентификатор (ARN) мобильного эндпоинта.

Подробнее см. на странице Действие CreatePlatformEndpoint.

Отправьте уведомление

Явные уведомления (Bright Push)

export IAM_TOKEN=<IAM-токен>
curl \
  --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  --data-urlencode "Action=Publish" \
  --data-urlencode "ResponseFormat=JSON" \
  --data-urlencode "TargetArn=<идентификатор_эндпоинта>" \
  --data-urlencode "Message={"default": "<текст_уведомления>", "GCM": "{ \"notification\": { \"body\": \"<текст_уведомления>\"} }" }" \
  --data-urlencode "MessageStructure=json" \
  "https://notifications.yandexcloud.net/"

Где:

  • IAM_TOKEN — IAM-токен.
  • Action — тип операции.
  • ResponseFormat — формат ответа: JSON или XML.
  • TargetArn — идентификатор (ARN) мобильного эндпоинта.
  • Message — сообщение.
  • MessageStructure — формат сообщения.

Тихие уведомления (Silent Push)

export IAM_TOKEN=<IAM-токен>
curl \
  --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  --data-urlencode "Action=Publish" \
  --data-urlencode "ResponseFormat=JSON" \
  --data-urlencode "TargetArn=<идентификатор_эндпоинта>" \
  --data-urlencode "Message={\"data\": { \"key\": \"value\" } }" \
  --data-urlencode "MessageStructure=json" \
  "https://notifications.yandexcloud.net/"

Где:

  • IAM_TOKEN — IAM-токен.
  • Action — тип операции.
  • ResponseFormat — формат ответа: JSON или XML.
  • TargetArn — идентификатор (ARN) мобильного эндпоинта.
  • Message — сообщение.
  • MessageStructure — формат сообщения.

Подробнее см. на странице Действие Publish.

Предыдущая
Обзор
Следующая
Ошибки