Addon - Create Or Update Apple
Creates the Apple addon on a title, or updates it if it already exists.
POST https://titleId.playfabapi.com/Addon/CreateOrUpdateAppleRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| AppBundleId | True |
string |
iOS App Bundle ID obtained after setting up your app in the App Store. |
| AppSharedSecret |
string |
iOS App Shared Secret obtained after setting up your app in the App Store. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
||
| ErrorIfExists |
boolean |
If an error should be returned if the addon already exists. |
|
| IgnoreExpirationDate |
boolean |
Ignore expiration date for identity tokens. Be aware that when set to true this can invalidate expired tokens in the case where Apple rotates their signing keys. |
|
| RequireSecureAuthentication |
boolean |
Require secure authentication only for this app. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Create |
|
|
Create |
|
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
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 |
CreateOrUpdateAppleRequest
| Name | Type | Description |
|---|---|---|
| AppBundleId |
string |
iOS App Bundle ID obtained after setting up your app in the App Store. |
| AppSharedSecret |
string |
iOS App Shared Secret obtained after setting up your app in the App Store. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| ErrorIfExists |
boolean |
If an error should be returned if the addon already exists. |
| IgnoreExpirationDate |
boolean |
Ignore expiration date for identity tokens. Be aware that when set to true this can invalidate expired tokens in the case where Apple rotates their signing keys. |
| RequireSecureAuthentication |
boolean |
Require secure authentication only for this app. |
CreateOrUpdateAppleResponse
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
Error Codes
| Name | Code |
|---|---|
| AddonAlreadyExists | 19008 |
| BillingInformationRequired | 1266 |
| CatalogBadRequest | 4013 |
| CatalogConfigInvalid | 4010 |
| InvalidEntityType | 1373 |
| InvalidParams | 1000 |
| InvalidTitleId | 1004 |