Связаться с намиПодключиться

Действие CreatePlatformApplication

Статья создана
Обновлена 24 сентября 2024 г.

Создает канал мобильных Push-уведомлений.

HTTP-запрос

POST https://notifications.yandexcloud.net/

Query-параметры

Параметр Описание
Action string
Обязательное поле.
Параметр для обозначения типа операции.
Значение: CreatePlatformApplication.
Name string
Обязательное поле.
Имя канала уведомлений. Должно быть уникальным в облаке. Может содержать строчные и заглавные буквы латинского алфавита, цифры, подчеркивания, дефисы и точки. Допустимая длина — от 1 до 256 символов. Рекомендуется для каналов APNs указывать в имени идентификатор приложения (Bundle ID), для FCM и HMS — полное название пакета приложения (Package name).
Пример: com.example.app.
Platform string
Обязательное поле.
Платформа для отправки мобильных Push-уведомлений.
Возможные значения:
FolderId string
Обязательное поле.
Идентификатор каталога, в котором создается канал уведомлений.
Пример: b1gsm0k26v1l********.
Attributes.entry.N.key string
Обязательное поле.
Ключ атрибута. N — числовое значение.
Пример: Attributes.entry.1.key=PlatformPrincipal&Attributes.entry.2.key=PlatformCredential.
Attributes.entry.N.value string
Обязательное поле.
Значение атрибута. N — числовое значение.
Пример: Attributes.entry.1.value=c8gzjriSVxDDzX2fAV********&Attributes.entry.2.value=CgB6e3x9iW/qiE9l9wAUPK0e/bJQe5uIgTlYUD4bP********.
ResponseFormat string
Формат ответа.
Возможные значения:
  • XML (по умолчанию).
  • JSON.

Атрибуты

Общие атрибуты

Атрибут Описание
Description string
Описание приложения.
Пример: Test application.

Атрибуты APNS и APNS_SANDBOX

Атрибут Описание
PlatformPrincipal string
Идентификатор токена в формате .p8 или SSL-сертификат в формате .p12. Аутентификация с токеном является предпочтительной, как более современная.
PlatformCredential string
Токен или закрытый ключ SSL-сертификата.
ApplePlatformTeamID string
Идентификатор разработчика, только при использовании токена.
ApplePlatformBundleID string
Идентификатор приложения (Bundle ID), только при использовании токена.

Атрибуты FCM

Атрибут Описание
PlatformCredential string
Ключ сервисного аккаунта Google Cloud в формате JSON для аутентификации с помощью HTTP v1 API или API-ключ (server key) для аутентификации с помощью Legacy API. Версия HTTP v1 API является предпочтительной, так как с июня 2024 года Legacy API не будет поддерживаться FCM.

Атрибуты HMS

Атрибут Описание
PlatformPrincipal string
Идентификатор ключа.
PlatformCredential string
API-ключ.

Подробнее об атрибутах для аутентификации см. в подразделе Каналы мобильных Push-уведомлений.

Ответ

Успешный ответ

При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.

Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.

Схема данных:

<?xml version="1.0" encoding="UTF-8"?>
<CreatePlatformApplicationResponse>
    <ResponseMetadata>
  	  <RequestId>string</RequestId>
    </ResponseMetadata>
    <CreatePlatformApplicationResult>
  	  <PlatformApplicationArn>string</PlatformApplicationArn>
    </CreatePlatformApplicationResult>
</CreatePlatformApplicationResponse>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "CreatePlatformApplicationResult": {
    "PlatformApplicationArn": "string"
  }
}

Где:

  • RequestId — идентификатор запроса.
  • PlatformApplicationArn — идентификатор (ARN) канала уведомлений.

Ответ с ошибкой

При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом и дополнительным описанием в формате XML или JSON в зависимости от указанного параметра ResponseFormat.

Схема данных:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponseXML>
    <RequestId>string</RequestId>
    <Error>
  	  <Code>string</Code>
  	  <Message>string</Message>
    </Error>
</ErrorResponseXML>

{
  "ErrorResponse": {
    "RequestId": "string",
    "Error": {
      "Code": "string",
      "SubCode": "string",
      "Message": "string"
    }
  }
}

Где:

  • RequestId — идентификатор запроса.
  • Code — код ошибки.
  • Message — описание ошибки.

Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.

Ошибки, специфичные для действия CreatePlatformApplication:

HTTP Код ошибки Описание
400 InvalidParameter Канал мобильных Push-уведомлений с такими именем и платформой уже существует.
400 InvalidParameter Имя и платформа не могут быть использованы для создания нового канала мобильных Push-уведомлений, поскольку канал с такими же параметрами был недавно удален, данные мобильной платформы еще не обновлены.

См. также

Предыдущая
Ошибки
Следующая
GetAttributes