Skip to main content

AsyncAPI for integration service 0.0.1 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Table of Contents

Operations

PUB dlcSync Operation

Message dlcSynced

message is sent when a user's dlc is fulfilled or revoked

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.dlcobject---additional properties are allowed
payload.dlc.dlcIdstringaccelbyte dlc id---
payload.dlc.namespacestringnamespace---
payload.dlc.obtainedAtstringtime when the dlc is obtained-format (date-time)-
payload.dlc.platformstringdlc platformallowed ("EPICGAMES", "OCULUS", "PSN", "STEAM", "XBOX")--
payload.dlc.revokedAtstringtime when the dlc is revoked-format (date-time)-
payload.dlc.sourcesarray<string>service labels for PSN---
payload.dlc.sources (single item)string----
payload.dlc.statusstringdlc statusallowed ("FULFILLED", "REVOKED", "REVOKE_FAILED")--
payload.dlc.thirdPartyIdstringthird party (see 'platform') product id---
payload.dlc.transactionIdstringaccelbyte transaction id---
payload.dlc.userIdstringaccelbyte user id---
payload.dlc.versionintegerdlc versionallowed (0, 1)--
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"dlc": {
"dlcId": "string",
"namespace": "string",
"obtainedAt": "2019-08-24T14:15:22Z",
"platform": "EPICGAMES",
"revokedAt": "2019-08-24T14:15:22Z",
"sources": [
"string"
],
"status": "FULFILLED",
"thirdPartyId": "string",
"transactionId": "string",
"userId": "string",
"version": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB iapConfigManagement Operation

Accepts one of the following messages:

Message appleIAPConfigDeleted

message is sent when apple IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message appleIAPConfigUpdated

message is sent when apple IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message googleIAPConfigDeleted

message is sent when google IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message googleIAPConfigUpdated

message is sent when google IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message googleP12FileUpdated

message is sent when google IAP certificate is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message playStationIAPConfigDeleted

message is sent when psn IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message playStationIAPConfigUpdated

message is sent when psn IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message steamIAPConfigUpdated

message is sent when steam IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message steamIAPConfigDeleted

message is sent when steam IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message xblIAPConfigDeleted

message is sent when xbox IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message xblIAPConfigUpdated

message is sent when xbox IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message xblBPCertFileUpdated

message is sent when xbox IAP business partner cer is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message stadiaIAPJsonFileUpdated

this is deprecated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message stadiaIAPConfigDeleted

this is deprecated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message epicGamesIAPConfigDeleted

message is sent when epic IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message epicGamesIAPConfigUpdated

message is sent when epic IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message twitchIAPConfigUpdated

message is sent when twitch IAP config is updated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

Message twitchIAPConfigDeleted

message is sent when twitch IAP config is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB iapNotification Operation

Message notificationProcessed

The message is sent when AGS processes a valid Google or Apple IAP notification, such as when a subscription is renewed or refunded. For more Google/Apple notification details, please refer to the following links https://developer.android.google.cn/google/play/billing/rtdn-reference#sub-example & https://developer.apple.com/documentation/appstoreservernotifications/app_store_server_notifications_v2

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.notificationobject---additional properties are allowed
payload.notification.namespacestringAGS namespace---
payload.notification.userIdstringAGS user id.---
payload.notification.notificationPlatformstringnotification platformallowed ("GOOGLE", "APPLE")--
payload.notification.notificationPayloadobjectnotification payload--additional properties are allowed
payload.notification.statusstringstatusallowed ("PROCESSED", "ERROR", "WARN", "IGNORED")--
payload.notification.notificationTypestringnotification type, Subscription/OneTimePurchase/VoidPurchase/Test/UNKNOWN belongs to Google Play, other belongs to Apple Storeallowed ("DID_CHANGE_RENEWAL_PREF", "EXPIRED", "GRACE_PERIOD_EXPIRED", "RENEWAL_EXTENDED", "DID_RENEW", "SUBSCRIBED", "REVOKE", "REFUND", "REFUND_REVERSED", "OFFER_REDEEMED", "DID_CHANGE_RENEWAL_STATUS", "DID_FAIL_TO_RENEW", "PRICE_INCREASE", "REFUND_DECLINED", "CONSUMPTION_REQUEST", "RENEWAL_EXTENSION", "EXTERNAL_PURCHASE_TOKEN", "ONE_TIME_CHARGE", "TEST", "Subscription", "OneTimePurchase", "VoidPurchase", "Test", "UNKNOWN")--
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"notification": {
"namespace": "string",
"userId": "string",
"notificationPlatform": "GOOGLE",
"notificationPayload": {},
"status": "PROCESSED",
"notificationType": "DID_CHANGE_RENEWAL_PREF"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

PUB iapProcessing Operation

Message iapProcessed

message is sent when IAP order is fulfilled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.iapobject---additional properties are allowed
payload.iap.iapOrderNostringiap order number---
payload.iap.namespacestringnamespace---
payload.iap.userIdstringuser id---
payload.iap.productIdstringproduct id---
payload.iap.transactionIdstringtransaction id---
payload.iap.statusstringstatusallowed ("VERIFIED", "FULFILLED", "FAILED")--
payload.iap.statusReasonstringreason of current status---
payload.iap.regionstringcountry value from ISO countries---
payload.iap.languagestringlanguage value from language tag---
payload.iap.quantityintegernumber of items---
payload.iap.sandboxbooleana flag indicates whether the user has sanbox permission---
payload.iap.typestringIAP typeallowed ("APPLE", "GOOGLE", "PLAYSTATION", "STEAM", "XBOX", "EPICGAMES", "TWITCH")--
payload.iap.fulfilledTimestringtime when fulfillment is completed-format (date-time)-
payload.iap.pricenumber--format (double)-
payload.iap.currencystring----
0 (allOf item)object---additional properties are allowed
idstringevent id---
versioninteger----
namestringevent name---
namespacestringevent namespace---
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession id---

Examples of payload (generated)

{
"payload": {
"iap": {
"iapOrderNo": "string",
"namespace": "string",
"userId": "string",
"productId": "string",
"transactionId": "string",
"status": "VERIFIED",
"statusReason": "string",
"region": "string",
"language": "string",
"quantity": 0,
"sandbox": true,
"type": "APPLE",
"fulfilledTime": "2019-08-24T14:15:22Z",
"price": 0,
"currency": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}