Configurar notificación push

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.

Error codes

This operation may return the following PlayFab errors:

Error	Code
PushServiceError	1095
ValueAlreadyExists	1031

POST

Admin

SetupPushNotification

Setup Push Notification

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SetupPushNotification \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Platform": "APNS_SANDBOX",
  "Key": "MyKey123",
  "Credential": "MyCredentialsXYZ"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SetupPushNotification"

payload = {
    "Platform": "APNS_SANDBOX",
    "Key": "MyKey123",
    "Credential": "MyCredentialsXYZ"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Platform: 'APNS_SANDBOX', Key: 'MyKey123', Credential: 'MyCredentialsXYZ'})
};

fetch('https://{titleId}.playfabapi.com/Admin/SetupPushNotification', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SetupPushNotification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Platform' => 'APNS_SANDBOX',
    'Key' => 'MyKey123',
    'Credential' => 'MyCredentialsXYZ'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SetupPushNotification"

	payload := strings.NewReader("{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SetupPushNotification")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SetupPushNotification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "ARN": "arn:aws:iam::123456789012:user/David"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizaciones

X-SecretKey

string

header

requerido

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Cuerpo

application/json

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.

Credential

string

requerido

Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM

OverwriteOldARN

boolean

requerido

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

enum<string>

requerido

supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android

Opciones disponibles:

GCM,

APNS,

APNS_SANDBOX

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.

Respuesta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Ejemplo:

{
  "ARN": "arn:aws:iam::123456789012:user/David"
}

Última modificación el 6 de octubre de 2026

⌘I

Setup Push Notification

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SetupPushNotification \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Platform": "APNS_SANDBOX",
  "Key": "MyKey123",
  "Credential": "MyCredentialsXYZ"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SetupPushNotification"

payload = {
    "Platform": "APNS_SANDBOX",
    "Key": "MyKey123",
    "Credential": "MyCredentialsXYZ"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Platform: 'APNS_SANDBOX', Key: 'MyKey123', Credential: 'MyCredentialsXYZ'})
};

fetch('https://{titleId}.playfabapi.com/Admin/SetupPushNotification', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SetupPushNotification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Platform' => 'APNS_SANDBOX',
    'Key' => 'MyKey123',
    'Credential' => 'MyCredentialsXYZ'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SetupPushNotification"

	payload := strings.NewReader("{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SetupPushNotification")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SetupPushNotification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Platform\": \"APNS_SANDBOX\",\n  \"Key\": \"MyKey123\",\n  \"Credential\": \"MyCredentialsXYZ\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "ARN": "arn:aws:iam::123456789012:user/David"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Configurar notificación push

Error codes

Autorizaciones

Cuerpo

Respuesta