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

Статья создана

Yandex Cloud

Обновлена 14 февраля 2025 г.

Подготовьте облако к работе
Получите статический ключ доступа
Настройте AWS SDK
Создайте канал уведомлений
Получите список каналов уведомлений
Создайте эндпоинт
Отправьте уведомление
См. также

Примечание

Сервис находится на стадии Preview.

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

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

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

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

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

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

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

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

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

Создайте сервисный аккаунт.
Назначьте сервисному аккаунту роль editor на каталог.
Для сервисного аккаунта создайте статический ключ доступа.

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

Настройте AWS SDK

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

Установите Go.
Инициализируйте локальный проект в выбранной директории:
```
go mod init example
```

Установите необходимые модули:

go get github.com/aws/aws-sdk-go-v2
go get github.com/aws/aws-sdk-go-v2/config
go get github.com/aws/aws-sdk-go-v2/service/sns

Создайте клиент:

package main

import (
    "github.com/aws/aws-sdk-go-v2/aws"
    "github.com/aws/aws-sdk-go-v2/service/sns"
)

var endpoint = string("https://notifications.yandexcloud.net/")
var credProvider = aws.CredentialsProviderFunc(func(context.Context) (aws.Credentials, error) {
    cred := aws.Credentials{
        AccessKeyID:     "<идентификатор_статического_ключа>",
        SecretAccessKey: "<секретный_ключ>",
    }
    return cred, nil
})

func main() {
    config := aws.NewConfig()
    config.BaseEndpoint = &endpoint
    config.Region = "ru-central1"
    config.Credentials = credProvider
    client := sns.NewFromConfig(*config)
}

Где:

AccessKeyID — идентификатор статического ключа.
SecretAccessKey — секретный ключ.

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

attributes := map[string]string{}
attributes["<тип_аутентификации>"] = "<ключ>"
name := "<имя_канала>"
platform := "<тип_платформы>"
createPlatformApplicationInput := sns.CreatePlatformApplicationInput{
    Attributes: attributes,
    Name:       &name,
    Platform:   &platform,
}

createPlatformApplicationOutput, err := client.CreatePlatformApplication(context.TODO(), &createPlatformApplicationInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Platform application ARN:", *createPlatformApplicationOutput.PlatformApplicationArn)
}

Где:

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-ключ.
name — имя канала уведомлений, задается пользователем. Должно быть уникальным в облаке. Может содержать строчные и заглавные буквы латинского алфавита, цифры, подчеркивания, дефисы и точки. Допустимая длина — от 1 до 256 символов. Рекомендуется для каналов APNs указывать в имени идентификатор приложения (Bundle ID), для FCM и HMS — полное название пакета приложения (Package name).
platform — тип мобильной платформы:
- APNS и APNS_SANDBOX — Apple Push Notification service (APNs). Для тестирования приложения используйте APNS_SANDBOX.
- GCM — Firebase Cloud Messaging (FCM).
- HMS — Huawei Mobile Services (HMS).

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

apps, err := client.ListPlatformApplications(context.TODO(), &sns.ListPlatformApplicationsInput{})
if err != nil {
    log.Println(err.Error())
} else {
    for _, app := range apps.PlatformApplications {
  fmt.Println("Application ARN:", *app.PlatformApplicationArn)
    }
}

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

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

appArn := "<ARN_канала_уведомлений>"
token := "<Push-токен>"
createPlatformEndpointInput := sns.CreatePlatformEndpointInput{
    PlatformApplicationArn: &appArn,
    Token:                  &token,
}

createPlatformEndpointOutput, err := client.CreatePlatformEndpoint(context.TODO(), &createPlatformEndpointInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Endpoint ARN:", *createPlatformEndpointOutput.EndpointArn)
}

Где:

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

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

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

Apple iOS (APNs)

Google Android (GCM)

targetArn := "<ARN_ендпоинта>"
message := `{"default": "<текст_уведомления>", "APNS": "{\"aps\": {\"alert\": \"<текст_уведомления>\"}}"}`
messageStructure := "json"
publishInput := sns.PublishInput{
    TargetArn:        &targetArn,
    Message:          &message,
    MessageStructure: &messageStructure,
}

publishOutput, err := client.Publish(context.TODO(), &publishInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Message id:", *publishOutput.MessageId)
}

targetArn := "<ARN_ендпоинта>"
message := `{"default": "<текст_уведомления>", "GCM": "{\"notification\": {\"body\": \"<текст_уведомления>\"}}"}`
messageStructure := "json"
publishInput := sns.PublishInput{
    TargetArn:        &targetArn,
    Message:          &message,
    MessageStructure: &messageStructure,
}

publishOutput, err := client.Publish(context.TODO(), &publishInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Message id:", *publishOutput.MessageId)
}

Где:

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

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

Apple iOS (APNs)

Google Android (GCM)

targetArn := "<ARN_ендпоинта>"
message := `{"default": "<текст_уведомления>", "APNS": "{\"key\": \"value\"}"}`
messageStructure := "json"
publishInput := sns.PublishInput{
    TargetArn:        &targetArn,
    Message:          &message,
    MessageStructure: &messageStructure,
}

publishOutput, err := client.Publish(context.TODO(), &publishInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Message id:", *publishOutput.MessageId)
}

targetArn := "<ARN_ендпоинта>"
message := `{"default": "<текст_уведомления>", "GCM": "{\"data\": {\"key\": \"value\"}}"}`
messageStructure := "json"
publishInput := sns.PublishInput{
    TargetArn:        &targetArn,
    Message:          &message,
    MessageStructure: &messageStructure,
}

publishOutput, err := client.Publish(context.TODO(), &publishInput)
if err != nil {
    log.Println(err.Error())
} else {
    fmt.Println("Message id:", *publishOutput.MessageId)
}

Где:

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

SMS-сообщения

phoneNumber := "<номер_телефона>"
message := "<текст_уведомления>"
dataType := "String"
stringValue := "<текстовое_имя_отправителя>"
messageAttributes := map[string]types.MessageAttributeValue{}
messageAttributes["AWS.SNS.SMS.SenderID"] = types.MessageAttributeValue{
  DataType:    &dataType,
  StringValue: &stringValue,
}
publishSMSInput := sns.PublishInput{
  Message:           &message,
  PhoneNumber:       &phoneNumber,
  MessageAttributes: messageAttributes,
}
publishSMSOutput, err := client.Publish(context.TODO(), &publishSMSInput)
if err != nil {
  log.Println(err.Error())
} else {
  fmt.Println("Message id:", *publishSMSOutput.MessageId)
}

Где:

phoneNumber — номер телефона получателя.
message — текст уведомления.
stringValue — текстовое имя отправителя.

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

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

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

Настройте AWS SDKНастройте AWS SDK

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

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

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

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

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

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

SMS-сообщенияSMS-сообщения

См. такжеСм. также

Была ли статья полезна?

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

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

Настройте AWS SDK

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

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

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

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

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

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

SMS-сообщения

См. также