How to get started with the AWS SDK for PHP in Yandex Cloud Notification Service

To get started with the AWS SDK for PHP:

1. Get your cloud ready.
2. Get a static access key.
3. Configure the AWS SDK.
4. Create a notification channel.
5. Get a list of channels.
6. Create an endpoint.
7. Send a notification.

Get your cloud readyGet your cloud ready

Sign up for Yandex Cloud and create a billing account:

1. Go to the management console and log in to Yandex Cloud or create an account if you do not have one yet.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one.

If you have an active billing account, you can go to the cloud page to create or select a folder for your infrastructure to operate in.

Learn more about clouds and folders.

Get a static access keyGet a static access key

For authentication in Cloud Notification Service, use a static access key. The key is issued for the service account, and all actions are performed on behalf of that service account.

To get a static access key:

1. Create a service account.

2. Assign the service account the editor role for the folder.

3. Create a static access key for the service account.

   Save the ID and private key.

Configure the AWS SDKConfigure the AWS SDK

1. Review the system requirements.

2. Install PHP 5.5 or higher.

   When using the AWS SDK, do not disable the SimpleXML PHP extension.

3. Install Composer to manage PHP dependencies.

4. Add the AWS SDK library for PHP into your project:

   • If Composer in your system is installed globally, run this command in your project's root folder:

     composer require aws/aws-sdk-php
     

   • If Composer is not installed globally, run this command:

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

   For other installation methods, see the AWS documentation.

5. Create a client:

   <?php
   
   require '/<path_to_folder>/vendor/autoload.php';
   
   use Aws\Sns\SnsClient;
   
   $client = new SnsClient(
       [
           'endpoint' => 'https://notifications.yandexcloud.net/',
           'version' => 'latest',
           'region' => 'ru-central1',
           'credentials' => [
               'key' => '<static_key_ID>',
               'secret' => '<secret_key>',
           ],
       ]
   );
   
   ?>
   

   Where:

   • /<path_to_folder>/vendor/autoload.php: Path to the autoload.php file created when installing the AWS SDK.
   • key: Static key ID.
   • secret: Secret key.

Create a notification channelCreate a notification channel

$response = $client->createPlatformApplication(
    [
        'Name' => '<channel_name>',
        'Platform' => 'GCM',
        'Attributes' => [
            'PlatformCredential' => '<FCM_API_key>',
        ],
    ]
);

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

Where:

• Name: Notification channel name, user-defined. The name must be unique within the cloud. It may contain lowercase and uppercase Latin letters, numbers, underscores, hyphens, and periods. It may be from 1 to 256 characters long. For APNs channels, we recommend specifying the bundle ID in the name, and for FCM and HMS, the full package name.
• Platform: Mobile platform type:
  • APNS and APNS_SANDBOX: Apple Push Notification service (APNs). Use APNS_SANDBOX to test the application.
  • GCM: Firebase Cloud Messaging (FCM).
  • HMS: Huawei Mobile Services (HMS).
• Attributes: Mobile platform authentication parameters in key=value format. The values depend on platform:

  • APNs:

    • Token-based authentication:
      • PlatformPrincipal: Path to the token signature key file from Apple.
      • PlatformCredential: Key ID.
      • ApplePlatformTeamID: Team ID.
      • ApplePlatformBundleID: Bundle ID.
    • Certificate-based authentication:

      • PlatformPrincipal: SSL certificate in .pem format.

      • PlatformCredential: Certificate private key in .pem format.

        To save the certificate and the private key in individual .pem files, use the openssl Linux utility:

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

    Token-based authentication: The more modern and secure method.

  • FCM: PlatformCredential is the Google Cloud service account key in JSON format for authentication with the HTTP v1 API or API key (server key) for authentication with the legacy API.

    Use the HTTP v1 API because the FCM legacy API is no longer supported starting July 2024.

  • HMS:

    • PlatformPrincipal: Key ID
    • PlatformCredential: API key

As a result, you will get a notification channel ID (ARN).

Get a list of notification channelsGet a list of notification channels

$response = $client->listPlatformApplications();

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

You will get the list of notification channels located in the same folder as the service account.

Create an endpointCreate an endpoint

$response = $client->createPlatformEndpoint(
    [
        'PlatformApplicationArn' => '<notification_channel_ARN>',
        'Token' => '<push_token>',
    ]
);

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

Where:

• PlatformApplicationArn: Notification channel ID (ARN).
• Token: Unique push token for the app on the user’s device.

As a result, you will get a mobile endpoint ID (ARN).

Send a notificationSend a notification

Mobile push notificationsMobile push notifications

$response = $client->publish(
  [
      'TargetArn' => '<endpoint_ID>',
      'Message' => json_encode([
          'default' => '<notification_text>',
          'APNS' => json_encode([
              'aps' => [
                  'alert' => '<notification_text>',
              ],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

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

$response = $client->publish(
  [
      'TargetArn' => '<endpoint_ID>',
      'Message' => json_encode([
          'default' => '<notification_text>',
          'GCM' => json_encode([
              'notification' => [
                  'title' => '<notification_title>',
                  'body' => '<notification_text>',
              ],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

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

$response = $client->publish(
  [
      'TargetArn' => '<endpoint_ID>',
      'Message' => json_encode([
          'default' => '<notification_text>',
          'GCM' => json_encode([
              'data' => ['<key>' => '<value>'],
          ])
      ]),
      'MessageStructure' => 'json',
  ]
);

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

Where:

• TargetArn: Mobile endpoint ID (ARN)
• MessageStructure: Message format
• Message: Message

Text messageText message

$response = $client->publish(
  [
      'Message' => '<message>',
      'PhoneNumber' => '<phone_number>',
  ]
);

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

See alsoSee also

• Getting started
• AWS CLI
• Concepts