Действие CreatePlatformApplication
Создает канал мобильных Push-уведомлений.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
Параметр |
Описание |
|
string |
|
string |
|
string
|
|
string |
|
string |
|
string |
|
string
|
Атрибуты
Общие атрибуты
Атрибут | Описание |
---|---|
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-ключ. |
Атрибуты RUSTORE
Атрибут | Описание |
---|---|
PlatformPrincipal |
string Идентификатор проекта. |
PlatformCredential |
string Сервисный токен. |
Подробнее об атрибутах для аутентификации см. в подразделе Каналы мобильных 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 | AppAlreadyExists | Канал мобильных Push-уведомлений с такими именем и платформой уже существует. |
400 | InvalidParameter | DeletedAppAlreadyExists | Имя и платформа не могут быть использованы для создания нового канала мобильных Push-уведомлений, поскольку канал с такими же параметрами был недавно удален, данные мобильной платформы еще не обновлены. |