Как начать работать с push-уведомлениями в Yandex Cloud Notification Service

1. В консоли управления выберите каталог, в котором вы хотите создать канал уведомлений.

2. В списке сервисов выберите Cloud Notification Service.

3. Нажмите Создать канал уведомлений.

4. На вкладке Мобильные Push-уведомления выберите платформу для отправки:

   • Apple iOS — для iOS-устройств.
   • Google Android — для Android-устройств c установленными сервисами Google Play.
   • Huawei Android — для Android-устройств c установленными сервисами Huawei.
   • RuStore Android — для Android-устройств c установленным магазином приложений RuStore.

5. В зависимости от платформы задайте параметры аутентификации:

   Apple iOS

   • Выберите Метод аутентификации: Токен или Сертификат.

     • Для аутентификации с помощью токена понадобятся:

       • Ключ подписи — файл с ключом подписи, которым будет заверяться токен аутентификации.

         Создайте и скачайте ключ подписи в своей учетной записи разработчика Apple: Certificates, Identifiers & Profiles → Keys → . Скачать файл ключа можно только один раз.

       • Идентификатор ключа (Key ID) — узнайте идентификатор в учетной записи разработчика Apple: Certificates, Identifiers & Profiles → Keys. Убедитесь, что идентификатор соответствует ключу подписи, который вы загрузили на предыдущем шаге. Должен содержать 10 символов.

       • Идентификатор разработчика (Team ID) — указан в правом верхнем углу вашей учетной записи разработчика Apple. Должен содержать 10 символов: только цифры и буквы латинского алфавита.

       • Идентификатор приложения (Bundle ID) — узнайте Bundle ID в учетной записи разработчика Apple: Certificates, Identifiers & Profiles → Identifiers или в приложении Xcode: Target → General → Identity. Может содержать только цифры, буквы латинского алфавита, дефисы и точки.

       Подробнее о токене см. в документации Apple.

     • Для аутентификации с помощью сертификата понадобятся:

       • Сертификат — файл сертификата SSL в формате .pem.
       • Закрытый ключ сертификата — файл ключа в формате .pem.

       Подробнее о сертификате см. в документации Apple.

       Чтобы сохранить сертификат и закрытый ключ в отдельных файлах формата .pem, вы можете воспользоваться утилитой openssl в Linux:

       openssl pkcs12 -in Certificates.p12 -nokeys -nodes -out certificate.pem
       openssl pkcs12 -in Certificates.p12 -nocerts -nodes -out privatekey.pem
       

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

   • Выберите Окружение: Development или Production. Для тестирования приложения используйте Development.

   Google Android

   Укажите, какая Версия FCM API будет использоваться: HTTP v1 или Legacy.

   Вы можете аутентифицироваться на мобильной платформе FCM через API:

   • HTTP v1 API — понадобится Ключ сервисного аккаунта Google Cloud в формате JSON. С помощью ключа генерируются временные токены OAuth 2.0 для аутентификации запросов в FCM HTTP v1 API. Можно получить в консоли управления Google Cloud.
   • Legacy API — понадобится API-ключ (server key). Можно получить в консоли управления Firebase.

   Примечание

   С июня 2024 года Legacy API не поддерживается FCM.

   Подробнее см. в документации Firebase.

   Huawei Android

   Познакомьтесь с документацией HMS и получите параметры для аутентификации:

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

   RuStore Android

   Познакомьтесь с документацией RuStore и получите параметры для аутентификации:

   • ID проекта.
   • Сервисный токен.

   Параметры аутентификации можно получить в консоли разработчика RuStore: Push-уведомления → Проекты.

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

7. (опционально) Нажмите Добавить описание и введите описание для канала уведомлений.

8. Нажмите Создать.

1. Выберите канал уведомлений, созданный ранее.
2. Перейдите на вкладку Эндпоинты.
3. Нажмите кнопку Создать эндпоинт.
4. Введите Токен устройства — уникальный токен на устройстве пользователя, созданный сервисом уведомлений для приложения.
5. (опционально) Введите Данные пользователя — текст длиной до 2048 символов в кодировке UTF-8.
6. Нажмите кнопку Создать.

Создание эндпоинта может занять некоторое время.

1. Выберите эндпоинт, созданный ранее.
2. В блоке Отправка сообщений выберите формат уведомления: Текст или JSON.
3. Введите текст уведомления или JSON-объект, содержащий данные уведомления.
4. Нажмите кнопку Отправить.

Каждому отправленному уведомлению присваивается уникальный идентификатор. Чтобы сохранить его, нажмите кнопку Скопировать идентификатор.

Вы можете сразу же отправить новое уведомление или повторить предыдущее.