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

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

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

1. Ознакомьтесь с системными требованиями.

2. Установите PHP версии 5.5 или выше.

   При работе с AWS SDK не отключайте расширение SimpleXML PHP extension.

3. Установите Composer для управления зависимостями PHP.

4. Добавьте библиотеку AWS SDK для PHP в ваш проект:

   • Если Composer установлен в системе глобально, то в корневом каталоге вашего проекта выполните команду:

     composer require aws/aws-sdk-php
     

   • Если Composer не установлен глобально, выполните команду:

     php composer.phar require aws/aws-sdk-php
     

   Другие способы установки см. в документации AWS.

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

   <?php
   
   require '/<путь_до_каталога>/vendor/autoload.php';
   
   use Aws\Sns\SnsClient;
   
   $client = new SnsClient(
       [
           'endpoint' => 'https://notifications.yandexcloud.net/',
           'version' => 'latest',
           'region' => 'ru-central1',
           'credentials' => [
               'key' => '<идентификатор_статического_ключа>',
               'secret' => '<секретный_ключ>',
           ],
       ]
   );
   
   ?>
   

   Где:

   • /<путь_до_каталога>/vendor/autoload.php — путь к файлу autoload.php, который создается при установке AWS SDK.
   • key — идентификатор статического ключа.
   • secret — секретный ключ.

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

$response = $client->createPlatformApplication(
    [
        'Name' => '<имя_канала>',
        'Platform' => '<тип_платформы>',
        'Attributes' => [
            '<параметр1>' => '<значение1>',
            ...
            '<параметрN>' => '<значениеN>'
        ],
    ]
);

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

  • 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-ключ.

  • RuStore:

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

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

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

$response = $client->listPlatformApplications();

var_dump($response->get('PlatformApplications'));

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

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

$response = $client->createPlatformEndpoint(
    [
        'PlatformApplicationArn' => '<ARN_канала_уведомлений>',
        'Token' => '<Push-токен>',
    ]
);

print($response->get('EndpointArn'));

Где:

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

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

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

Мобильные Push-уведомления

$response = $client->publish(
  [
      'TargetArn' => '<идентификатор_эндпоинта>',
      'Message' => json_encode([
          'default' => '<текст_уведомления>',
          'APNS' => json_encode([
              'aps' => [
                  'alert' => '<текст_уведомления>',
              ],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

print($response->get('MessageId'));

$response = $client->publish(
  [
      'TargetArn' => '<идентификатор_эндпоинта>',
      'Message' => json_encode([
          'default' => '<текст_уведомления>',
          'GCM' => json_encode([
              'notification' => [
                  'title' => '<заголовок_уведомления>',
                  'body' => '<текст_уведомления>',
              ],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

print($response->get('MessageId'));

$response = $client->publish(
  [
      'TargetArn' => '<идентификатор_эндпоинта>',
      'Message' => json_encode([
          'default' => '<текст_уведомления>',
          'GCM' => json_encode([
              'data' => ['<ключ>' => '<значение>'],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

print($response->get('MessageId'));

Где:

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

SMS-сообщения

$response = $client->publish(
  [
      'Message' => '<сообщение>',
      'PhoneNumber' => '<номер_телефона>',
  ]
);

print($response->get('MessageId'));

См. также

• Начало работы
• AWS CLI
• Концепции