/application/configuration

Previous/application Next/auth

Last updated 11 days ago

Creates a new iOS ApplicationConfiguration

Creates a new iOS ApplicationConfiguration with the specific ID or application.

post

/application/{applicationNameOrId}/configuration/ios

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Facebook ApplicationConfiguration

Creates a new Facebook ApplicationConfiguration with the specific ID or application.

post

/application/{applicationNameOrId}/configuration/facebook

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsany

The set of built-in permissions connected clients will need to request.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "applicationSecret": null,
    "builtinApplicationPermissions": []
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Facebook Application Configuration

Gets a single Facebook application based on unique name or ID.

get

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Facebook ApplicationConfiguration

Updates an existing Facebook Application profile if it is known to the server.

put

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsany

The set of built-in permissions connected clients will need to request.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "applicationSecret": null,
    "builtinApplicationPermissions": []
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Facebook ApplicationConfiguration

Deletes an existing Facebook Application profile if it is known to the server.

delete

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Firebase ApplicationConfiguration

Creates a new Firebase ApplicationConfiguration with the specific ID or application.

post

/application/{applicationNameOrId}/configuration/firebase

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "projectId": null,
    "serviceAccountCredentials": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Firebase Application Configuration

Gets a single Firebase application based on unique name or ID.

get

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Firebase ApplicationConfiguration

Updates an existing Firebase Application profile if it is known to the server.

put

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "projectId": null,
    "serviceAccountCredentials": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Firebase ApplicationConfiguration

Deletes an existing Firebase Application profile if it is known to the server.

delete

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Google Play ApplicationConfiguration

Creates a new GooglePlay ApplicationConfiguration with the specific ID or application.

post

/application/{applicationNameOrId}/configuration/google_play

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdany

jsonKeyany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "jsonKey": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Google Play Application Configuration

Gets a single Google Play application based on unique name or ID.

get

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Google Play ApplicationConfiguration

Updates an existing Google Play Application profile if it is known to the server.

put

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdany

jsonKeyany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "jsonKey": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Google Play ApplicationConfiguration

Deletes an existing Google Play Application profile if it is known to the server.

delete

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a iOS Application Configuration

Gets a single iOS application based on unique name or ID.

get

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a iOS ApplicationConfiguration

Updates an existing iOS Application profile if it is known to the server.

put

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a iOS ApplicationConfiguration

Deletes an existing iOS Application profile if it is known to the server.

delete

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new PSN ApplicationConfiguration

Creates a new PSN ApplicationConfiguration with the specific ID or application.

post

/application/{applicationNameOrId}/configuration/psn

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

npIdentifieranyrequired

Pattern: ^\S+$

clientSecretanyrequired

Pattern: ^\S+$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "npIdentifier": null,
    "clientSecret": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a PSN Application Configuration

Gets a single PSN application based on unique name or ID.

get

/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a PSN ApplicationConfiguration

Updates an existing PSN Application profile if it is known to the server.

put

/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

npIdentifieranyrequired

Pattern: ^\S+$

clientSecretanyrequired

Pattern: ^\S+$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "npIdentifier": null,
    "clientSecret": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a PSN ApplicationConfiguration

Deletes an existing PSN Application profile if it is known to the server.

delete

/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new iOS ApplicationConfiguration

Show child attributes

Creates a new Facebook ApplicationConfiguration

Show child attributes

Gets a Facebook Application Configuration

Updates a Facebook ApplicationConfiguration

Show child attributes

Deletes a Facebook ApplicationConfiguration

Creates a new Firebase ApplicationConfiguration

Show child attributes

Gets a Firebase Application Configuration

Updates a Firebase ApplicationConfiguration

Show child attributes

Deletes a Firebase ApplicationConfiguration

Creates a new Google Play ApplicationConfiguration

Show child attributes

Gets a Google Play Application Configuration

Updates a Google Play ApplicationConfiguration

Show child attributes

Deletes a Google Play ApplicationConfiguration

Gets a iOS Application Configuration

Updates a iOS ApplicationConfiguration

Show child attributes

Deletes a iOS ApplicationConfiguration

Creates a new PSN ApplicationConfiguration

Show child attributes

Gets a PSN Application Configuration

Updates a PSN ApplicationConfiguration

Show child attributes

Deletes a PSN ApplicationConfiguration