Как начать работать с AWS SDK для JavaScript в Yandex Cloud Notification Service

Чтобы начать работу с AWS SDK для JavaScript:

1. Подготовьте облако к работе.
2. Получите статический ключ доступа.
3. Настройте AWS SDK.
4. Создайте канал уведомлений.
5. Получите список каналов.
6. Создайте эндпоинт.
7. Отправьте уведомление.

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

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

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

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

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

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

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

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

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

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

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

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

Настройте AWS SDK

Пререквизиты и инструкция по установке AWS SDK для JavaScript также описаны в документации AWS.

1. Установите Node.js.

2. Инициализируйте проект в выбранной директории:

   npm init -y
   

3. Установите пакет с AWS SNS клиентом:

   npm i @aws-sdk/client-sns
   

4. Добавьте "type": "module" в файл package.json, чтобы использовать ESM синтаксис.

5. Создайте клиент в файле index.js:

   import * as AWS from "@aws-sdk/client-sns";
   
   const snsClient = new AWS.SNSClient({
       endpoint: "https://notifications.yandexcloud.net/",
       region: "ru-central1",
       credentials: {
           accessKeyId: "<идентификатор_статического_ключа>",
           secretAccessKey: "<секретный_ключ>",
       },
   })
   

6. Команда для запуска программы

   node index.js
   

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

const response = await client.send(
    new AWS.CreatePlatformApplicationCommand({
        Name: "<имя_канала>",
        Platform: "<тип_платформы>",
        Attributes: { <тип_аутентификации>: "<ключ>" },
    })
);
console.log(`PlatformApplication ARN: ${response.PlatformApplicationArn}`);

Где:

• 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 — параметры аутентификации на мобильной платформе в формате ключ=значение. Значения зависят от типа платформы:

  • APNs:

    • Аутентификация с токеном:

      • PlatformPrincipal — путь к файлу с ключом подписи токена, полученный в Apple.
      • PlatformCredential — идентификатор ключа подписи (Key ID).
      • ApplePlatformTeamID — идентификатор разработчика (Team ID).
      • ApplePlatformBundleID — идентификатор приложения (Bundle ID).

    • Аутентификация с сертификатом:

      • PlatformPrincipal — SSL-сертификат в формате .pem.

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

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

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

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

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

    Используйте HTTP v1 API, так как с июля 2024 года FCM legacy API не поддерживается.

  • HMS:

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

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

const response = await client.send(new AWS.ListPlatformApplicationsCommand({}));
console.log(
    response.PlatformApplications.map(
        (t) => `Application ARN: ${t.PlatformApplicationArn}`
    ).join("\n")
);

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

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

const response = await client.send(
    new AWS.CreatePlatformEndpointCommand({
        PlatformApplicationArn: "<ARN_канала_уведомлений>",
        Token: "<Push-токен>",
    })
);
console.log(`Endpoint ARN: ${response.EndpointArn}`);

Где:

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

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

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

const message = {
    default: "<текст_уведомления>",
    APNS: JSON.stringify({
        aps: {
            alert: "<текст_уведомления>",
        },
    }),
};

const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<ARN_эндпоинта>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

const message = {
    default: "<текст_уведомления>",
    GCM: JSON.stringify({
        notification: {
            body: "<текст_уведомления>",
        },
    }),
};
const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<ARN_эндпоинта>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

Где:

• message — сообщение.
• TargetArn — идентификатор (ARN) мобильного эндпоинта.
• MessageStructure — формат сообщения.

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

const message = {
    default: "<текст_уведомления>",
    APNS: JSON.stringify({
        key: "value",
    }),
};
const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<ARN_эндпоинта>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

const message = {
    default: "<текст_уведомления>",
    GCM: JSON.stringify({
        data: {
            key: "value",
        },
    }),
};

const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<ARN_эндпоинта>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

Где:

• message — сообщение.
• TargetArn — идентификатор (ARN) мобильного эндпоинта.
• MessageStructure — формат сообщения.

SMS-сообщения

const response = await client.send(
    new AWS.PublishCommand({
        PhoneNumber: "<номер_телефона>",
        Message: "<текст_уведомления>",
        MessageAttributes: {
            "AWS.SNS.SMS.SenderID": {
                DataType: "String",
                StringValue: "<текстовое_имя_отправителя>"
            }
        }
    })
);
console.log(`Message id: ${response.MessageId}`);

Где:

• PhoneNumber — номер телефона получателя.
• Message — текст уведомления.
• StringValue — текстовое имя отправителя.

См. также

• Начало работы
• AWS CLI
• Концепции
• Документация AWS