Applications

PreviousElements 3.0.X (Preview)NextFriends and Followers

Last updated 7 months ago

Search Applications

get

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

searchanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Get an Application

get

Gets the metadata for a single application. This may include more specific details not availble in the bulk-get or fetch operation.

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Deletes an Application

delete

Deletes a specific application known to the server.

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Gets a Facebook Application Configuration

get

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

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"
}

Deletes a Facebook ApplicationConfiguration

delete

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

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"
}

Gets a Firebase Application Configuration

get

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

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"
}

Deletes a Firebase ApplicationConfiguration

delete

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

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"
}

Gets a Google Play Application Configuration

get

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

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"
}

Deletes a Google Play ApplicationConfiguration

delete

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

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

get

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

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"
}

Deletes a iOS ApplicationConfiguration

delete

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

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"
}

Deletes a iOS ApplicationConfiguration

delete

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

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/matchmaking/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets a iOS Application Configuration

get

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Searches application profiles

get

Searches all instances of ApplicationProfiles associated with the application. The search query may be a full text search.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Query parameters

offsetany · default: 0optional

countany · default: 20optional

searchanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates the ProductBundle

put

Updates the ProductBundle for the given ApplicationConfiguration

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationIdanyrequired

Body

anyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/{applicationConfigurationId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '[
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ]'

400

401

403

404

409

500

501

503

default

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

Creates a New Application

post

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

Authorizations

Body

nameanyrequired

Pattern: [^_]\w+

descriptionanyoptional

attributesanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "description": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

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

Updates an Application

put

Performs an update to an existing application known to the server.

Authorizations

Path parameters

nameOrIdanyrequired

Body

nameanyrequired

Pattern: [^_]\w+

descriptionanyoptional

attributesanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "description": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

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

Creates a new Facebook ApplicationConfiguration

post

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

builtinApplicationPermissionsanyoptional

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,
      "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"
}

Updates a Facebook ApplicationConfiguration

put

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

builtinApplicationPermissionsanyoptional

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,
      "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"
}

Creates a new Firebase ApplicationConfiguration

post

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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,
      "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"
}

Updates a Firebase ApplicationConfiguration

put

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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,
      "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"
}

Creates a new Google Play ApplicationConfiguration

post

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

applicationIdanyoptional

jsonKeyanyoptional

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,
      "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"
}

Updates a Google Play ApplicationConfiguration

put

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

applicationIdanyoptional

jsonKeyanyoptional

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,
      "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"
}

Creates a new iOS ApplicationConfiguration

post

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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,
      "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"
}

Updates a iOS ApplicationConfiguration

put

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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,
      "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 iOS ApplicationConfiguration

post

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

schemeanyrequired

A user-sepecified unqiue identifier for the matching scheme. It is possible to specify multiple schemes per application, but each must be uniquely named. Each scheme allows for the specification of different scripts to handle the successful match. When requesting matchmaking services clients will specify the scheme to be used.

Pattern: [^_]\w+

algorithmundefined · enumrequired

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

Options: FIFO

successobjectrequired

Defines a script method and a module to invoke.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": 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
      }
    ],
    "scheme": null,
    "algorithm": "FIFO",
    "success": {
      "module": null,
      "method": null
    }
  }'

400

401

403

404

409

500

501

503

default

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

Updates a iOS ApplicationConfiguration

put

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

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

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, GOOGLE_SIGN_IN

uniqueIdentifieranyoptional

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

parentobjectrequired

productBundlesanyoptional

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

schemeanyrequired

Pattern: [^_]\w+

algorithmundefined · enumrequired

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

Options: FIFO

successobjectrequired

Defines a script method and a module to invoke.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": 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
      }
    ],
    "scheme": null,
    "algorithm": "FIFO",
    "success": {
      "module": null,
      "method": null
    }
  }'

400

401

403

404

409

500

501

503

default

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

Search Applications

Get an Application

Deletes an Application

Gets a Facebook Application Configuration

Deletes a Facebook ApplicationConfiguration

Gets a Firebase Application Configuration

Deletes a Firebase ApplicationConfiguration

Gets a Google Play Application Configuration

Deletes a Google Play ApplicationConfiguration

Gets a iOS Application Configuration

Deletes a iOS ApplicationConfiguration

Deletes a iOS ApplicationConfiguration

Gets a iOS Application Configuration

Searches application profiles

Updates the ProductBundle

Creates a New Application

Updates an Application

Creates a new Facebook ApplicationConfiguration

Show child attributes

Updates a Facebook ApplicationConfiguration

Show child attributes

Creates a new Firebase ApplicationConfiguration

Show child attributes

Updates a Firebase ApplicationConfiguration

Show child attributes

Creates a new Google Play ApplicationConfiguration

Show child attributes

Updates a Google Play ApplicationConfiguration

Show child attributes

Creates a new iOS ApplicationConfiguration

Show child attributes

Updates a iOS ApplicationConfiguration

Show child attributes

Creates a new iOS ApplicationConfiguration

Show child attributes

Show child attributes

Updates a iOS ApplicationConfiguration

Show child attributes

Show child attributes