Title-Wide Data Management - Setup Push Notification
Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported.
POST https://titleId.playfabapi.com/Admin/SetupPushNotificationRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| Credential | True |
string |
Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM |
| OverwriteOldARN | True |
boolean |
replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if notifications have already setup for this platform. |
| Platform | True |
supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android |
|
| Key |
string |
for APNS, this is the PlatformPrincipal (SSL Certificate) |
|
| Name |
string |
This field is deprecated and any usage of this will cause the API to fail. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Push |
|
|
Setup |
When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true. |
|
Setup |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
PushSetupPlatform
| Name | Type | Description |
|---|---|---|
| APNS |
string |
|
| APNS_SANDBOX |
string |
|
| GCM |
string |
SetupPushNotificationRequest
When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true.
| Name | Type | Description |
|---|---|---|
| Credential |
string |
Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM |
| Key |
string |
for APNS, this is the PlatformPrincipal (SSL Certificate) |
| Name |
string |
This field is deprecated and any usage of this will cause the API to fail. |
| OverwriteOldARN |
boolean |
replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if notifications have already setup for this platform. |
| Platform |
supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android |
SetupPushNotificationResult
| Name | Type | Description |
|---|---|---|
| ARN |
string |
Amazon Resource Name for the created notification topic. |
Error Codes
| Name | Code |
|---|---|
| PushServiceError | 1095 |
| ValueAlreadyExists | 1031 |