Game > Gamebase > API v1.3 Guide

Updates

• New items have been added to or deleted from the request parameters and response results of IAP (In App Purchase) API.
• Added the Push Wrapping API.
• Added the Get IdP Token and Profiles API that lets you acquire the profile and token info of the IdP used for logging in with the Gamebase Access Token.
• Added the Get UserId Information with IdP Id API which acquires the Gamebase userId mapped with IdP Id.
• Added the Withdraw Histories API to get Gamebase userId of users who have withdrawn during a specific period.
• Added the Ban and Ban Release APIs that perform ban and ban release.
• Added the Get Payment Transaction API to query payment transaction.
• Added marketIds to the List Consumables API that queries the unconsumed payment history so that multiple stores can be viewed at a time.
• The server address has changed to https://api-gamebase.nhncloudservice.com. The previous address will be maintained until further notice.
• Added linkedPaymentId to response results of the List Active Subscriptions API, indicating the market payment number for the originally transacted subscription when canceling or repurchasing subscription products.
• Added the Cancel Subscriptions and Revoke Subscriptions APIs that cancel the products in subscripion.
• Added includeInactiveGoogleStatuses to the List Active Subscriptions API request body to request inactive Google subscription statuses.
• Added renewTime to the List Active Subscriptions API response result to indicate when RENEWED/RECOVERED occurred.
• Added marketIds to the List Active Subscriptions API request to perform querying against N stores at once.
• Added the Get Ban Members API to retrieve users who are banned from using the service
• Added the Get Subscription Status API to retrieve the current status of subscriptions
• Added a paymentToken to the Get Payment Transaction API request body, representing the ONEStore's purchaseId or purchaseToken value.

Advance Notice

Gamebase Server API provides APIs as follows, in the RESTful format. Following information is required to use Server API.

Server Address

To call API, below address is needed, which is also available in the Gamebase Console.

https://api-gamebase.nhncloudservice.com

AppId

App ID, as a project ID of NHN Cloud, can be found on the Project List page of the Console.

SecretKey

Secret Key, as a control access of API, can be found in the Gamebase Console. It must be set at the HTTP header to call Server API.

[Note]
When a secret key is exposed and a wrong call is made, click Create to create a new secret key and replace the old one.

TransactionId

As part of managing API internally within a server that calls API, TransactionId is provided. By setting a transaction ID at the HTTP header from a calling server to call API, the Gamebase server delivers results with corresponding TransactionId set at the response HTTP Header and Response Body Header of results.

Common

HTTP Header

Following items should be set at the HTTP Header to call API.

Name	Required	Value
Content-Type	Required	application/json; charset=UTF-8
X-Secret-Key	Required	Refer to description of SecretKey
X-TCGB-Transaction-Id	Optional	Refer to description of TransactionId

API Response

As a response to all API requests, HTTP 200 OK is delivered. Whether an API request is successful or not can be determined in reference of the Header of Response Body.

[Request]

Content-Type: application/json
X-TCGB-Transaction-Id: 88a1ae42-6b1d-48c8-894e-54e97aca07fq
X-Secret-Key: IgsaAP
GET https://api-gamebase.nhncloudservice.com

[Response]

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-TCGB-Transaction-Id: 88a1ae42-6b1d-48c8-894e-54e97aca07fq

{
    "header": {
        "transactionId": "88a1ae42-6b1d-48c8-894e-54e97aca07fq",
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "Success."
    }
}

Key	Type	Description
transactionId	String	The value set at HTTP Header when API is requested. If the value is not delivered, return value that is created within Gamebase.
isSuccessful	boolean	Whether it is successful or not.
resultCode	int	Result code 0 for success; return error codes, for failure
resultMessage	String	Result message

API Version

When a specific variable type in the API response result changes, the API version changes. That is, even if a new API is added or a new variable is added to the response result, the API version does not change.

[Caution] Make sure that you add the option of the JSON library you are using so that a JSON parsing error does not occur even if a new variable is added to the API response result.

Authentication

Token Authentication

Authenticates an Access Token issued to a login user. If it is normal, returns information of the corresponding user.

[Method, URI]

Method	URI
GET	/tcgb-gateway/v1.3/apps/{appId}/members/{userId}/tokens/{accessToken}?linkedIdP=false

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
userId	String	ID of the logged-in user
accessToken	String	Access Token issued to the logged-in user

[Request Parameter]

Name	Type	Required	Value
linkedIdP	boolean	Optional	True or false (Default is false) Whether IdP-related information, used when Access Token is issued, is included or not

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "String",
        "isSuccessful": true
    },
    "linkedIdP": {
        "idPCode": "String",
        "idPId": "String"
    },
    "member": {
        "userId": "String",
        "valid": "Y",
        "appId": "String",
        "regDate": "2019-08-27T17:41:05+09:00",
        "lastLoginDate": "2019-08-27T17:41:05+09:00",
        "authList": [
            {
                "userId": "String",
                "authSystem": "String",
                "idPCode": "String",
                "authKey": "String",
                "regDate": "2019-08-27T17:41:05+09:00"
            },
            {
                "userId": "String",
                "authSystem": "String",
                "idPCode": "String",
                "authKey": "String",
                "regDate": "2019-08-27T17:41:05+09:00"
            }
        ],
        "temporaryWithdrawal": {
            "gracePeriodDate": "2020-04-18T09:12:01+09:00"
        }
    }
}

Key	Type	Description
linkedIdP	Object	Logged-in user's IdP information
linkedIdP.idPCode	String	User authentication IdP
linkedIdP.idPId	String	IdP ID
member.userId	String	User ID
member.lastLoginDate	String	Last login time ISO 8601 Not available for a first-time login user
member.appId	String	appId
member.valid	String	User status Value of a successful login user is "Y"
member.regDate	String	Time when a user created an account
authList	Array[Object]	Information related to user authentication IdP
authList[].authSystem	String	Authentication system internally used within Gamebase User authentication system to be provided
authList[].idPCode	String	User authentication IdP
authList[].authKey	String	User classification value issued per IdP ID by authSystem
temporaryWithdrawal	Object	Information related to pending withdrawal Provided only when the value of valid is "T"
temporaryWithdrawal.gracePeriodDate	String	Expiration time for pending withdrawal ISO 8601

[Error Code]

Error Code

Get IdP Token and Profiles

Gamebase Access Token which is issued upon successful login with "Login with IdP" from the client side. It retrieves the Access Token and Profiles information of the IdP used for login.

[Caution] IdP's Access Token expiration date varies by IdP, and they are usually short. If you successfully log in with "Login as the Latest Login IdP" from the client and call the API from the server, you may not be able to acquire IdP info because IdP's Access Token has been expired.

[Note] There are also IdPs that are unable to acquire information with the IdP's Access Token only. Example: appleid / iosgamecenter / kakaogame : There is no information you can retrieve from Server to Server with Access Token.

[Method, URI]

Method	URI
GET	/tcgb-gateway/v1.3/apps/{appId}/members/{userId}/idps/{idPCode}?accessToken={accessToken}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
userId	String	ID of the logged-in user
idPCode	String	User authentication IdP

[Request Parameter]

Name	Type	Required	Value
accessToken	String	Required	Gamebase Access Token issued to the logged-in user

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "transactionId": "String",
        "isSuccessful": true
    },
    "idPProfile": {
        "sub": "String",
        "name": "String",
        "given_name": "String",
        "locale": "ko",
        "picture": "String"
    },
    "idPToken": {
        "idPCode": "google",
        "accessToken": "ya29.a0AfH6SMCF-MjD_-Eqi62Jm-51IPxnS6HpahqpxqbuaWZPXc68YMmW3sRdif4k7Dmp2Ppn1xzH-JQwPLDv4tMrDFAknG4m_lrHQt4J4En7DAG0bZV4z8uJZE1zYOXHp8"
    }
}

Key	Type	Description
idPProfile	Map	IdP's profile used by the logged-in user - All IdPs have different response formats
idPToken	Object	Access Token information of IdP used by the logged-in user
idPToken.idPCode	String	User authentication IdP
idPToken.accessToken	String	IdP Access Token

Launching

Get Simple Launching

In the console, you can view the launching information provided when starting up a client app, such as the server address, install URL, current maintenance status, maintenance time, and messages. To check only if the current maintenance setting is enabled, use [Check Maintenance] API.

[Method, URI]

Method	URI
GET	/tcgb-launching/v1.3/apps/{appId}/launching/simple

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud Project ID

[Request Parameter]

Name	Type	Required	Value
osCode	OsCode	true	OS code
storeCode	Enum	true	Store code
clientVersion	String	true	Client version

[Response Body]

OK

{
    "header": {
        "resultCode": 0,
        "resultMessage": "String",
        "isSuccessful": true
    },
    "launchingData": {
        "status": {
            "code": 200,
            "message": "String"
        },
        "app": {
            "storeCode": "String",
            "accessInfo": {
                "serverAddress": "String",
                "csInfo": "String"
            },
            "relatedUrls": {
                "termsUrl": "String",
                "csUrl": "String",
                "punishRuleUrl": "String",
                "personalInfoCollectionUrl": "String"
            },
            "install": {
                "url": "String"
            }
        }
    }
}

Maintenance

{
    "header": {
        "resultCode": 0,
        "resultMessage": "String",
        "isSuccessful": true
    },
    "launchingData": {
        "status": {
            "code": 303,
            "message": "String"
        },
        "app": {
            "storeCode": "String",
            "accessInfo": {
                "serverAddress": "String",
                "csInfo": "String"
            },
            "relatedUrls": {
                "termsUrl": "String",
                "csUrl": "String",
                "punishRuleUrl": "String",
                "personalInfoCollectionUrl": "String"
            },
            "install": {
                "url": "String"
            }
        },
        "maintenance": {
            "typeCode": "String",
            "beginDate": "2018-05-23T10:44:00+09:00",
            "endDate": "2022-01-01T10:44:00+09:00",
            "url": null,
            "reason": "String",
            "message": "String"
        }
    }
}

Key	Type	Description
status	Object	Information which shows the current client status
status.code	int	Client status code OK: 200 Update recommended: 201, Update required: 300 Service terminated: 302 Maintenance in progress: 303
status.message	String	Client status message
app	Object	App information
app.storeCode	String	Store code
app.accessInfo	Object	Information set on the console app screen
app.accessInfo.serverAddress	String	Server address The server address set on the client side has a higher priority. When no client server address is set, the server address set on the app screen is delivered.
app.accessInfo.csInfo	String	Customer Center information
app.relatedUrls	Object	In-app URL to be used within the app
app.relatedUrls.termsUrl	String	Terms and Conditions
app.relatedUrls.csUrl	String	Customer Center
app.relatedUrls.punishRuleUrl	String	Ban Rules
app.relatedUrls.personalInfoCollectionUrl	String	Privacy Information Agreement
app.install	Object	App Installation information
app.install.url	String	Install URL
maintenance	Object	Maintenance Information
maintenance.typeCode	String	Maintenance type code Overall maintenance : 'SYSTEM', Maintenance per App: 'APP'
maintenance.beginDate	Date	Maintenance start date ISO 8601
maintenance.endDate	Date	Maintenance end date ISO 8601
maintenance.url	String	Maintenance URL
maintenance.reason	String	Maintenance reason
maintenance.message	String	Default maintenance reason message

[Error Code]

Error code](./error-code/#server)

Member

Get Member

Retrieves detailed information of a single user.

[Method, URI]

Method	URI
GET	/tcgb-member/v1.3/apps/{appId}/members/{userId}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
userId	String	User ID to retrieve

[Request Parameter]

Name	Type	Required	Value
includeMemberInfo	boolean	Optional	true or false (default value: true) Whether to include detailed information of user device, OS, etc.

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "member": {
        "userId": "String",
        "valid": "Y",
        "appId": "String",
        "regDate": "2019-08-27T17:41:05+09:00",
        "lastLoginDate": "2019-08-27T17:41:05+09:00",
        "authList": [
            {
                "userId": "String",
                "authSystem": "String",
                "idPCode": "String",
                "authKey": "String",
                "regDate": "2019-08-27T17:41:05+09:00"
            }
        ]
    },
    "temporaryWithdrawal": {
        "gracePeriodDate": "2020-04-18T09:12:01+09:00"
    },
    "memberInfo": {
        "deviceCountryCode": "String",
        "usimCountryCode": "String",
        "language": "String",
        "osCode": "String",
        "telecom": "String",
        "storeCode": "String",
        "network": "String",
        "deviceModel": "String",
        "osVersion": "String",
        "sdkVersion": "String",
        "clientVersion": "String"
    }
}

Key	Type	Description
member	Object	Basic information of a retrieved user
member.userId	String	User ID
member.valid	Enum	User status
member.appId	String	appId
member.regDate	String	Time when a user created an account
member.lastLoginDate	String	Last login time Not available for a first-time login user or a withdrawn user
member.authList	Array[Object]	Information related to user authentication IdP
member.authList[].userId	String	User ID
member.authList[].authSystem	String	Authentication system used internally within Gamebase User authentication system to be provided
member.authList[].idPCode	String	User authentication IdP
member.authList[].authKey	String	User classification value issued per IdP ID by authSystem
member.authList[].regDate	String	Time when the IdP information was mapped with the user account
temporaryWithdrawal	Object	Information related to pending withdrawal Provided only when the value of valid is "T"
temporaryWithdrawal.gracePeriodDate	String	Expiration time for pending withdrawal ISO 8601
memberInfo	Object	Additional user information Not available for a withdrawn user
memberInfo.deviceCountryCode	String	Country code of user device
memberInfo.usmCountryCode	String	Country code of user USIM
memberInfo.language	String	User device language, ISO 639-1
memberInfo.osCode	String	OS code
memberInfo.telecom	String	Telecommunication provider
memberInfo.storeCode	String	Store code
memberInfo.network	String	Network environment e.g. 3G and WiFi
memberInfo.deviceModel	String	Model name of user device
memberInfo.osVersion	String	OS version of user device
memberInfo.sdkVersion	String	SDK version
memberInfo.clientVersion	String	Client version

[Error Code]

Error Code

Get Members

Retrieves brief information about multiple users.

[Method, URI]

Method	URI
POST	/tcgb-member/v1.3/apps/{appId}/members

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Body]

["userId", "userId", "userId"]

Type	Required	Value
Array[String]	Required	User ID to retrieve

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "memberList": [
        {
            "userId": "String",
            "valid": "Y",
            "appId": "String",
            "regDate": "2019-08-27T17:41:05+09:00"
        }
    ]
}

Key	Type	Description
memberList	Array [Object]	Basic information of retrieved users
memberList[].userId	String	User ID
memberList[].valid	Enum	User status
memberList[].appId	String	appId
memberList[].regDate	String	Time when a user created an account

[Error Code]

Error Code

Get IdP Information

Retrieves IdP information mapped with user ID.

[Method, URI]

Method	URI
POST	/tcgb-member/v1.3/apps/{appId}/auth/authKeys

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Body]

["userId", "userId", "userId"]

Type	Required	Value
Array[String]	Required	User ID to retrieve

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        "String": [
            {
                "authKey": "String",
                "idPCode": "gbid",
                "authSystem": "String"
            }
        ]
    }
}

Key	Type	Description
result	Array [Object]	Basic information of retrieved users An object with userId as key and IdP information as value
authkey	String	User classification value issued per IdP ID by authSystem
IdPCode	String	User authentication IdP
authSystem	String	Authentication system used internally within Gamebase Authentication system to be provided

[Error Code]

Error Code

Get UserId Information with Auth key

Retrieves a user ID mapped to user authentication key.

[Method, URI]

Method	URI
POST	/tcgb-member/v1.3/apps/{appId}/members/userIds/authKeys?authSystem={authSystem}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

Name	Type	Required	Value
authSystem	String	Required	Authentication system used internally within Gamebase User authentication system to be provided Currently provides gbid

[Request Body]

["authKey", "authKey", "authKey"]

Type	Required	Value
Array[String]	Required	authKey issued at authSystem

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        "String": "String"
    }
}

Key	Type	Description
result	Array [Object]	Basic information of a retrieved user An object with authKey as key, and useID as value.

[Error Code]

Error Code

Get UserId Information with IdP Id

Retrieves the information of user ID mapped with IdP ID.

[Method, URI]

Method	URI
POST	/tcgb-gateway/v1.3/apps/{appId}/idps/{idPCode}/members

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
idPCode	String	User authentication IdP

[Request Body]

["idPId", "idPId", "idPId"]

Type	Required	Value
Array[String]	Required	IdP ID of users to retrieve Max size of the list to be searched is 300

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        "idPId": "userId",
        "idPId": "userId",
        "idPId": "userId"
    }
}

Key	Type	Description
result	Map	ID info of the retrieved users - IdP ID is the key, and Gamebase userId is the value - If the userID info containing the IdP ID requested for retrieval does not exist, it won't be available in the response result.

[Error Code]

Error code

Ban

Changed users to the banned state.

[Method, URI]

Method	URI
POST	/tcgb-gateway/v1.3/apps/{appId}/members/ban

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Request Body]

{
    "userIdList": [
        "userId-1", "userId-2"
    ],
    "banTypeCode": "TEMPORARY",
    "end": "2022-05-10T06:03:50.000+09:00",
    "templateCode": 0,
    "banReason": "string",
    "flags": "leaderboard",
    "banCaller": "APP_SERVER",
    "regUser": "GAME-SERVER"
}

Key	Type	Description
userIdList	Array[String]	IDs of the users who are target for the ban
banTypeCode	Enum	Type of the ban. TEMPORARY or PERMANENT
end	String	End time for the ban (ISO 8601 standard time) - Required for TEMPORARY type
templateCode	Integer	Template code of the template used for the message to be displayed when the user is banned - The value can be found on the console's Ban > Template detailed query page
banReason	String	Reason for the ban
flags	String	To delete the banned users' leaderboard data as well, set it to 'leaderboard'
banCaller	String	The subject who called the Ban API. Set it to a fixed value of 'APP_SERVER'.
regUser	String	Name to display on the console's Ban page

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "failedUserIdList": ["userId-1"]
}

Key	Type	Description
failedUserIdList	Array[String]	IDs of the users who could not be registered for the ban

[Error Code]

Error code

Ban Histories

Retrieves the user ban history.

[Method, URI]

Method	URI
GET	/tcgb-member/v1.3/apps/{appId}/members/bans

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud Project ID

[Request Parameter]

Name	Type	Required	Value
begin	String	Required	Ban history query start time (ISO 8601 standard time, UTF-8 encoding required) Example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
end	String	Required	Ban history query end time (ISO 8601 standard time, UTF-8 encoding required) If banned between the begin and end time, the query result shows this.
page	String	Optional	Page to retrieve, starting from 0
size	String	Optional	Number of data per page
order	String	Optional	Sorting method for queried data. ASC or DESC

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "pagingInfo": {
        "first": true,
        "last": true,
        "numberOfElements": 0,
        "page": 0,
        "size": 0,
        "totalElements": 0,
        "totalPages": 0
    },
    "result": [
        {
            "userId": "String",
            "banCaller": "CONSOLE",
            "banReason": "String",
            "banType": "TEMPORARY",
            "beginDate": "2019-08-27T17:41:05+09:00",
            "endDate": "2019-08-28T17:41:05+09:00",
            "flags": "String",
            "name": "String",
            "templateCode": 0
        }
    ]
}

Key	Type	Description
pagingInfo	Object	Retrieved paging information
pagingInfo.first	boolean	True if it is the first page
pagingInfo.last	boolean	True if it is the last page
pagingInfo.numberOfElements	int	Total number of data
pagingInfo.page	int	Page No.
pagingInfo.size	int	Number of data per page
pagingInfo.totalElements	int	Total number of data
pagingInfo.totalPages	int	Total number of pages
result	Array[Object]	Retrieved ban history details
result.userId	String	User ID
result.banCaller	String	Subject of calling ban
result.banReason	String	Reason for the ban
result.banType	String	Type of the ban. TEMPORARY or PERMANENT
result.beginDate	Long	Start date of the ban
result.endDate	Long	End date of the ban In case of PERMANENT type, the value does not exist
result.flags	String	Returned as 'leaderboard' when you have selected Delete Leaderboard upon Registering Ban in the console.
result.name	String	Template name registered in the console
result.templateCode	Long	Code value of the ban template registered in the console

[Error Code]

Error code

Ban Release

Changes users to the ban released state, that is, the normal state.

[Method, URI]

Method	URI
DELETE	/tcgb-gateway/v1.3/apps/{appId}/members/ban

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Request Body]

{
    "userIdList": [
        "userId-1", "userId-2"
    ],
    "banReleaseReason": "string",
    "banReleaseCaller": "APP_SERVER",
    "releaseUser": "GAME-SERVER"
}

Key	Type	Description
userIdList	Array[String]	IDs of the users who are target for the ban release
banReleaseReason	String	Reason for the ban release
banReleaseCaller	String	Subject who called the Ban Release API. Set it to a fixed value of 'APP_SERVER'.
releaseUser	String	Name to display on the console's Ban Release page

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "failedUserIdList": ["userId-1"]
}

Key	Type	Description
failedUserIdList	Array[String]	IDs of the users who could not be released from a ban

[Error Code]

Error code

Ban Release Histories

Retrieves the user ban release history.

[Method, URI]

Method	URI
GET	/tcgb-member/v1.3/apps/{appId}/members/bans/release

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud Project ID

[Request Parameter]

Name	Type	Required	Value
begin	String	Required	Ban release history query start time (ISO 8601 standard time, UTF-8 encoding required) Example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
end	String	Required	Ban release history query end time (ISO 8601 standard time, UTF-8 encoding required) If unbanned between the begin and end time, the query result shows this.
page	String	Optional	Page to retrieve, starting from 0
size	String	Optional	Number of data per page
order	String	Optional	Sorting method for queried data. ASC or DESC

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "pagingInfo": {
        "first": true,
        "last": true,
        "numberOfElements": 0,
        "page": 0,
        "size": 0,
        "totalElements": 0,
        "totalPages": 0
    },
    "result": [
        {
            "userId": "String",
            "banCaller": "CONSOLE",
            "banReason": "String",
            "banType": "TEMPORARY",
            "beginDate": "2019-08-27T17:41:05+09:00",
            "endDate": "2019-08-29T17:41:05+09:00",
            "flags": "String",
            "name": "String",
            "templateCode": 0,
            "releaseCaller": "CONSOLE",
            "releaseDate": "2019-08-30T18:41:05+09:00",
            "releaseReason": "String"
        }
    ]
}

Key	Type	Description
pagingInfo	Object	Retrieved paging information
pagingInfo.first	boolean	True if it is the first page
pagingInfo.last	boolean	True if it is the last page
pagingInfo.numberOfElements	int	Total number of data
pagingInfo.page	int	Page No.
pagingInfo.size	int	Number of data per page
pagingInfo.totalElements	int	Total number of data
pagingInfo.totalPages	int	Total number of pages
result	Array[Object]	Retrieved ban information
result.userId	String	User ID
result.banCaller	String	Subject of calling the ban
result.banReason	String	Reason for the ban
result.banType	String	Type of the ban. TEMPORARY or PERMANENT
result.beginDate	String	Start date of the ban
result.endDate	String	End date of the ban
result.flags	String	Returned as 'leaderboard' if you have selected Delete Leaderboard when registering the ban in the console.
result.name	String	Template name registered in the console
result.templateCode	Long	Code value of the ban template registered in the console
result.releaseCaller	String	Subject of the ban release
result.releaseReason	String	Reason for the ban release
result.releaseDate	String	Date of the ban release

[Error Code]

Error code

Validate TransferAccount

Validates the ID and password issued for transferring the guest account. For valid TransferAccount, return issued userID information.

[Method, URI]

Method	URI
POST	/tcgb-gateway/v1.3/apps/{appId}/members/transfer-account

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud Project ID

[Request Parameter]

None

[Request Body]

{
    "account": {
        "id": "198704206255",
        "password": "Zw548q7zE"
    }
}

Key	Type	Description
account.id	String	ID to be validated
account.password	String	Password to be validated

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "member": {
        "userId": "String",
        "valid": "Y",
        "appId": "String",
        "regDate": "2019-08-27T17:41:05+09:00",
        "lastLoginDate": "2019-08-27T17:41:05+09:00"
    }
}

Key	Type	Description
member	Object	Basic information of the retrieved user
member.userId	String	User ID
member.valid	Enum	User status
member.appId	String	App ID
member.regDate	String	The time when the user created the account
member.lastLoginDate	String	The last login time Not available for a first-time login user

[Error Code]

Error code

Withdraw

Withdraws a user account.

[Note] If the account withdrawal has been implemented using the server withdraw API instead of the SDK's withdrawal API, the client needs to delete data such as cached tokens by calling the logout API of SDK after the successful withdrawal.

[Method, URI]

Method	URI
DELETE	/tcgb-gateway/v1.3/apps/{appId}/members/{userId}?regUser={regUser}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
userId	String	ID of the withdrawal target user

[Request Parameter]

Name	Type	Required	Value
regUser	String	Required	Enter the system or operator information of the entity that requested withdrawal without spaces - The information can be viewed in the withdrawl history from Console > the 'Member' page

[Request Body]

None

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

[Error Code]

Error code

Withdraw Histories

Retrieves users who have withdrawn during a specific period.

[Method, URI]

Method	URI
GET	/tcgb-member/v1.3/apps/{appId}/logs/withdrawal

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud Project ID

[Request Parameter]

Name	Type	Required	Value
begin	String	Required	History query start time (ISO 8601 standard time, UTF-8 encoding required) Only data within the last 1 year are provided
end	String	Required	History query end time (ISO 8601 standard time, UTF-8 encoding required) Example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX / 2021-09-11T00%3a00%3a00%2b09%3a00
page	String	Optional	Page to retrieve, starting from 0
size	String	Optional	Number of data per page
order	String	Optional	Sorting method for queried data. ASC or DESC

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "transactionId": "String",
        "isSuccessful": true
    },
    "pagingInfo": {
        "totalPages": 1,
        "totalElements": 2,
        "numberOfElements": 2,
        "first": true,
        "last": true,
        "page": 0,
        "size": 100
    },
    "result": [
        {
            "userId": "String",
            "date": "2022-03-27T17:40:00+09:00",
            "regUser": null
        },
        {
            "userId": "String",
            "date": "2022-03-27T17:41:05+09:00",
            "regUser": "String"
        }
    ]
}

Key	Type	Description
pagingInfo	Object	Retrieved paging information
pagingInfo.first	boolean	True if it is the first page
pagingInfo.last	boolean	True if it is the last page
pagingInfo.numberOfElements	int	Total number of data
pagingInfo.page	int	Page No.
pagingInfo.size	int	Number of data per page
pagingInfo.totalElements	int	Total number of data
pagingInfo.totalPages	int	Total number of pages
result	Array[Object]	Retrieved withdrawn user details
result.userId	String	User ID
result.date	String	Date of withdrawal
result.regUser	String	The entity that called the Withdraw API - If the value is null, the API has been called from the client SDK

[Error Code]

Error code

Maintenance

Check Maintenance Set

Checks whether maintenance is currently set.

[Method, URI]

Method	URI
GET	/tcgb-launching/v1.3/apps/{appId}/maintenances/under-maintenance

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Response Body]

{
    "header": {
        "transactionId": "String",
        "resultCode": 0,
        "resultMessage": "String",
        "isSuccessful": true
    },
    "appId": "",
    "underMaintenance": true,
    "maintenance": {
        "typeCode": "APP",
        "beginDate": "2017-01-01T12:10:00+07:00",
        "endDate": "2017-02-01T12:17:00+07:00",
        "url": "http://url.info",
        "reason" : "maintenance reason",
        "message": "maintenance message",
        "targetStores": [
            "GG",
            "AS",
            "ONESTORE"
        ]
    }
}

Key	Type	Description
underMaintenance	Boolean	Whether maintenance is currently set
maintenance	Object	Default maintenance information, if maintenance is set
maintenance.typeCode	Enum	APP: Maintenance set in a game SYSTEM: Maintenance set by the Gamebase system
maintenance.beginDate	String	Start time of maintenance. ISO 8601
maintenance.endDate	String	End time of maintenance. ISO 8601
maintenance.url	String	Detailed maintenance URL
maintenance.message	String	Maintenance message
maintenance.targetStores	Array[Enum]	Store code of a client for the maintenance setting of a particular client only

[Error Code]

Error Code

Coupon

Check Validation And Consume Coupon

Validates published coupon code and change coupon status via console. For valid coupons, change to consume status and return item information to be paid as response result.

[Method, URI]

Method	URI
POST	/tcgb-gateway/v1.3/apps/{appId}/members/{userId}/coupons/{couponCode}?storeCode={storeCode}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID
userId	String	User ID to use coupons
couponCode	String	Coupon code

[Request Parameter]

Name	Type	Required	Value
storeCode	String	Optional	If you set the coupon to be used only for apps installed from a specific store in the console, you must pass the store code - If it's usable at all stores, set the parameter to ALL or omit the parameter - Store code

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        "title": "Coupon Title",
        "benefits": [
            {
                "itemId": "heart",
                "amount": 10
            },
            {
                "itemId": "diamond",
                "amount": 20
            }
        ]
    }
}

Key	Type	Description
result	Object	Coupon Information
result.title	String	Coupon name
result.benefits	Array[Object]	Information of item to be provided
result.benefits.itemId	String	Item ID
result.benefits.amount	Integer	Item count

[Error Code]

Error Code

Purchase (IAP)

Consume

If the store payment (Google Play Store, App Store, ONEStore, etc.) has been made successfully, it issues the purchased items to the user, records the purchase history in the server, and then informs the Gamebase of the payment consumption. You can consume payment only once per payment, and the payment is not consumed if the payment status is not normal.

[Note] Only the item payment with the product type CONSUMABLE or CONSUMABLE_AUTO_RENEWABLE at the time of registration will be consumed. Can consume once per payment, and IAP regards any payment without consumption as not issuing the purchased item.

Unconsumed payment history can be viewed through SDK and View Unconsumed Payment History API. Even if the unconsumed payment history exists through the API, the provisioning history within the game server becomes the priority if the game server has the history about the item provisioning. (If an API timeout occurs due to a network failure, etc., there might be cases where payment is completed in Gamebase whereas the item is not issued to the user due to API response failure in the game server.)

[Note] If it is not possible to manage all item issuance history inside the game, a safety measure for a duplicate issuance or non-issuance issue is required, for example, by setting the request timeout of API to 10 seconds or longer, and logging the history at least when an API timeout occurs.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/consume

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Request Body]

{
    "paymentSeq": "2019091931571201",
    "accessToken": "90fD1bs1guXwY6aZ7rseEKYW_6gMCISjDASgten4MD6O7XZD7VRjZcs8OTm8lOQVFTegoY4WK78P2WQCMm7cx"
}

Name	Type	Required	Value
paymentSeq	String	Required	Payment number
accessToken	String	Required	Payment authentication token (not a login authentication token)

[Note] When client calls requestPurchase API, the purchaseToken for response is used as accessToken

[Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "result": {
        "price": 1500.0,
        "currency": "KRW",
        "productSeq": 1000292,
        "marketId": "GG",
        "gamebaseProductId": "tap_prod_001",
        "payload": "additional info"
    }
}

Key	Type	Description
result	Object	Basic payment information
result.price	Float	Payment price
result.currency	String	Payment currency
result.productSeq	Long	Item number Automatically generated value for external store items when registering a product in the console
result.marketId	String	Store code
result.gamebaseProductId	String	Gamebase product ID The value to be entered by user when registering products using the console
result.payload	String	Additional information configured in SDK

[Note] The gamebaseProductId value exists in the response result according to the SDK version and payment API used by the client.

[Note] In the game server, specified products (items) can be issued using the item number or store code together with the Gamebase product ID, but if multiple Gamebase products are registered with a single store item ID, the products need to be issued using the store code and Gamebase product ID.

[Error Code]

Error Code

List Consumables

Lists non-consumed payment, which is not consumed even if paid up.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/consumable

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Request Body]

{
    "marketIds": ["GG", "AS"],
    "userId": "QXG774PMRZMWR3BR"
}

Name	Type	Required	Value
marketId	String	Optional	Store code - Use marketIds as it will be deprecated
marketIds	Array	Optional	Store code - Retrieve all stores when the value is empty (or null) - However, all stores must be listed explicitly when retrieving all stores including AMAZON stores.
userId	String	Required	User ID

[Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "success"
    },
    "result": [
        {
            "paymentSeq": "2020060210364966",
            "productSeq": 1000312,
            "currency": "KRW",
            "price": 2500.0,
            "marketId": "AS",
            "accessToken": "ja5SBJBfr7rYUdjFr6dRe7gKnkX0r7EKPvuK6CIUBBekc1rE9CVbMKVCNuw6ZtwmcpDRXrToR9l26NF9zub6ol",
            "paymentId" : "Store Reference Key",
            "gamebaseProductId": "gamebase_prod_001",
            "purchaseTime": "2020-06-02T13:38:56+09:00",
            "payload": "additional info",
            "isTestPurchase" : false
        },
        {
            "paymentSeq": "2016122110023125",
            "productSeq": 1000292,
            "currency": "KRW",
            "price": 1000.0,
            "marketId": "AS",
            "accessToken": "7_3zXyNJub0FNLed3m9XRAAXsSxLWq698t8QyTzk3NeeSoytKxtKGjldTc1wkSktgzjsfkVTKE50DoGihsAvGQ",
            "paymentId" : "Store Reference Key",
            "gamebaseProductId": "gamebase_prod_002",
            "purchaseTime": "2020-06-02T13:37:42+09:00",
            "isTestPurchase" : false
        }
    ]
}

Key	Type	Description
result	Array[Object]	Basic payment information
result[].paymentSeq	String	Payment ID issued by Gamebase / Payment transaction ID
result[].productSeq	Long	Item number Automatically generated value for external store items when registering a product in the console
result[].currency	String	Payment currency
result[].price	Float	Payment price
result[].accessToken	String	Payment authentication token
result[].paymentId	String	Payment ID issued by the store
result[].marketId	String	Store code
result[].gamebaseProductId	String	Gamebase product ID The value entered by the user when registering a product in the console
result[].purchaseTime	String	Time and date of payment
result[].payload	String	Additional information configured in SDK For Amazon store, the value might be missing
result[].isTestPurchase	boolean	Whether it is a test purchase or not

[Error Code]

Error Code

Get Payment Transaction

You can check whether the non-consumed payment history obtained through the client SDK is valid. (If you want to validate the payment number (paymentSeq) and payment authentication token (accessToken) before calling the item issuance (consume) API on the server, call this API.)

[Method, URI]

Method	URI
GET	/tcgb-inapp/v1.3/apps/{appId}/payment/transaction?accessToken={accessToken}

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

Name	Type	Required	Value
accessToken	String	Required	Payment authentication token (purchaseToken)

[Request Body]

N/A

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        "paymentSeq": "2022041110385239",
        "productSeq": 1003150,
        "currency": "EUR",
        "price": 2.29,
        "marketId": "AS",
        "accessToken": "-Fr8Y7_dvv5qhdd6qVHbs7gKnkX0r7EKPvuK6CI-UBBekc1rE9CVbMKVCNuw6ZtwkBGlzeIHg6DdjaRVeaW7GYlPF4vRa50L8umB6tdBvk8",
        "paymentId" : "Store Reference Key",
        "paymentToken" : "19062709124410111299",
        "productType": "CONSUMABLE",
        "userId": "AS@QW4M1GM7W97YJDCN",
        "gamebaseProductId": "qa_ksw_prod_as_001",
        "purchaseTime": "2022-04-11T16:47:01+09:00",
        "payload" : "string",
        "isTestPurchase": true,
        "isConsumable": false
    }
}

Key	Type	Description
result	Object	Payment information
result.paymentSeq	String	Payment ID issued by Gamebase
result.productSeq	Long	Item number Automatically generated value for external store items when registering a product in the console
result.currency	String	Payment currency
result.price	Float	Payment price
result.marketId	String	Store code
result.accessToken	String	Payment authentication token
result.productType	String	Product (item) type - One-time: CONSUMABLE - Consumable Subscription: CONSUMABLE_AUTO_RENEWABLE - Subscription: AUTO_RENEWABLE
result.paymentId	String	Payment ID issued by the store
result.paymentToken	String	Payment token issued by the store and only exists for ONEStore payments - ONEStore V5: purchaseId - ONEStore V6,7: purchaseToken
result.userId	String	User ID
result.gamebaseProductId	String	Gamebase product ID The value entered by the user when registering a product in the console
result.purchaseTime	String	Time and date of payment
result.payload	String	Additional information configured in SDK For Amazon store, the value might be missing
result.isTestPurchase	boolean	Whether it is a test purchase or not - true: Test purchase
result.isConsumable	boolean	Whether Consume API can be called - true: Currently in non-consumed state, so Consume API can be called

[Error Code]

Error Code

List Active Subscriptions

Lists payment of user's current subscriptions.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/active-subscriptions

[Request Header]

Check common items.

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

N/A

[Request Body]

{
    "marketIds": [
        "GG",
        "AS"
    ],
    "packageName": "com.nhncloud.gamebase",
    "userId": "QXG774PMRZMWR3BR",
    "includeInactiveGoogleStatuses" : [
        "ON_HOLD"
    ]
}

Name	Type	Required	Value
marketId	String	Optional	Store code - Scheduled to be deprecated so marketIds used
marketIds	Array[String]	Optional	Store code - Lookup against all stores if the value is empty (or null)
packageName	String	Required	Store app ID registered on the console
userId	String	Required	User ID
includeInactiveGoogleStatuses	Array[String]	Optional	Google Subscription in Inactive Status to be included in response result - Currently only support 'ON_HOLD' status

[Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "result": [
        {
            "marketId": "GG",
            "userId": "QXG774PMRZMWR3BR",
            "paymentSeq": "2020052810364755",
            "accessToken": "NczL3n4TumMF8n9oRR5l8zXDyMXRVjxSRks0Lk1Saob2A9rdAupqjZSrQ0-hb2GOSFwTx5uDDchH8EB-EkWGGQ",
            "productSeq": 1001221,
            "productId": "money_100",
            "productType": "AUTO_RENEWABLE",
            "originalPaymentId": "GPA.3302-8679-7228-41195",
            "paymentId": "GPA.3302-8679-7228-41195",
            "linkedPaymentId": "GPA.3358-3220-2629-70624",
            "price": 1000.0,
            "currency": "KRW",
            "gamebaseProductId": "gamebase_renewal_001",
            "payload" : "additional info",
            "purchaseTime": "2020-06-02T13:38:56+09:00",
            "expiryTime": "2020-06-02T13:48:56+09:00",
            "renewTime" : "2020-06-02T13:50:56+09:00",
            "isTestPurchase" : false,
            "referenceStatus" : "PURCHASED"
        }
    ]
}

Key	Type	Description
result	Array[Object]	Basic payment information
result[].marketId	String	Store code
result[].userId	String	User ID
result[].paymentSeq	String	Payment number
result[].accessToken	String	Payment validation token
result[].productSeq	Long	Item number Automatically generated value for external store items when registering a product in the console
result[].productId	String	Identifier of product (item) registered at store
result[].productType	String	Product (item) type Subscription: AUTO_RENEWABLE
result[].currency	String	Payment currency
result[].price	Float	Payment price
result[].originalPaymentId	String	Initial store payment ID
result[].paymentId	String	Recently updated store payment ID
result[].linkedPaymentId	String	Payment ID for the original transaction when canceling/repurchasing subscription Currently only supported by Google Play Store
result[].gamebaseProductId	String	Gamebase product ID The value entered by the user when registering a product in the console
result[].payload	String	Additional information configured in SDK
result[].purchaseTime	String	Recent updated time
result[].expiryTime	String	Subscription expiration time
result[].renewTime	String	When RENEWED/RECOVERED occurred
result[].isTestPurchase	boolean	Whether it is a test purchase or not
result[].referenceStatus	String	Payment reference status provided by the payment system (in-app purchase, external payment) Currently only supported by Google Play Store

[Error Code]

Error Code

Cancel Subscriptions

Products in subscription is no longer renewed at the time of renewal, and the subscription will remain until it expires.

[Note] Currently only supported by Google Play Store.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/subscriptions/cancel

[Request Header]

Check common items

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

None

[Request Body]

{
    "paymentSeq": "2022112110400545",
    "accessToken": "NczL3n4TumMF8n9oRR5l8zXDyMXRVjxSRks0Lk1Saob2A9rdAupqjZSrQ0-hb2GOSFwTx5uDDchH8EB-EkWGGQ"
}

Name	Type	Required	Value
paymentSeq	String	Required	Payment number
accessToken	String	Required	Payment authentication token

[Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

[Error Code]

Error Code

Revoke Subscriptions

Cancel the current subscription immediately and proceed with a refund for the products in subscription.

[Note] Currently only supported by Google Play Store.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/subscriptions/revoke

[Request Header]

Check common items

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud proejct ID

[Request Parameter]

None

[Request Body]

{
    "paymentSeq": "2022112110400545",
    "accessToken": "NczL3n4TumMF8n9oRR5l8zXDyMXRVjxSRks0Lk1Saob2A9rdAupqjZSrQ0-hb2GOSFwTx5uDDchH8EB-EkWGGQ"
}

Name	Type	Required	Value
paymentSeq	String	Required	Payment number
accessToken	String	Required	Payment authentication token

[Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

[Error Code]

Error Code

Leaderboard

Gamebase provides Wrapping to server API of NHN Cloud Leaderboard. With Wrapping, NHN Cloud products become available at a user server on a consistent interface.

[Note] Once the Gamebase is activated, you can call Gamebase Wrapping API to use the Leaderboard function without setting the Leaderboard Appkey.

Wrapping API

API	Method	Wrapping URI	Leaderboard URI
Get user count in factor - Get user count in factor	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/user-count	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/user-count
Get total factor count - Get total factor count	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factor-count	/leaderboard/v2.0/appkeys/{appKey}/factor-count
Get factor info - Get factor info - Get multiple factor info	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factors	/leaderboard/v2.0/appkeys/{appKey}/factors
Get single user info (score/ranking) - Get single user info	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users?userId={userId}	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users?userId={userId}
Get multiple user info (score/ranking) - Get multiple user info	POST	/tcgb-leaderboard/v1.3/apps/{appId}/get-users	/leaderboard/v2.0/appkeys/{appKey}/get-users
Get the entire info (score/ranking) by range - Get multiple user info by range	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users?start={start}&size={size}	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users?start={start}&size={size}
Get selected rank user info - Get selected rank user info	POST	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users
Get ranking of a specific user or upper and lower users - Get multiple user info by pivot user	GET	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users?userId={userId}&prevSize={prevSize}&nextSize={nextSize}	/leaderboard/v2.0/appkeys/{appkey}/factors/{factor}/users?userId={userId}&prevSize={prevSize}&nextSize={nextSize}
Set single user score - Set single user score	POST	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users/{userId}/score	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users/{userId}/score
Set single user score with extra data - Set single user score with extra data	POST	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users/{userId}/score-with-extra	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users/{userId}/score-with-extra
Set multiple user score - Set multiple user score	POST	/tcgb-leaderboard/v1.3/apps/{appId}/scores	/leaderboard/v2.0/appkeys/{appKey}/scores
Set multiple user score with extra data - Set multiple user score with extra data	POST	/tcgb-leaderboard/v1.3/apps/{appId}/scores-with-extra	/leaderboard/v2.0/appkeys/{appKey}/score-with-extra
Delete user leaderboard information - Delete single user info - Delete multiple user info	DELETE	/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/users	/leaderboard/v2.0/appkeys/{appKey}/factors/{factor}/users

For more information of the API, click the following link. To find out about Leaderboard API specs mapped with Gamebase Wrapping API, see the following guide. Use the Gamebase AppId and SecretKey to call the Gamebase Wrapping Leaderboard API without setting the Leaderboard Appkey.

Leaderboard Guide

Example of API Call

GET https://api-gamebase.nhncloudservice.com/tcgb-leaderboard/v1.3/apps/{appId}/factors/{factor}/user-count

Content-Type: application/json
X-TCGB-Transaction-Id: 88a1ae42-6b1d-48c8-894e-54e97aca07fq
X-Secret-Key: IgsaAP

Push

Gamebase provides Wrapping function for the Server API of the NHN Cloud Push service. By using the Wrapping function, you can use the NHN Cloud services on the user server with consistent interfaces.

[Note] Once the Gamebase is activated, you can call the Gamebase Wrapping API to use the Push function without setting the Push Appkey.

Wrapping API

	API	Method	Wrapping URI	Push URI
Message	Send	POST	/tcgb-push/v1.3/apps/{appId}/messages	/push/v2.4/appkeys/{appkey}/messages
	View	GET	/tcgb-push/v1.3/apps/{appId}/messages	/push/v2.4/appkeys/{appkey}/messages
	View sent log	GET	/tcgb-push/v1.3/apps/{appId}/logs/message	/push/v2.4/appkeys/{appkey}/logs/message
Scheduled message	Create send schedule	POST	/tcgb-push/v1.3/apps/{appId}/schedules	/push/v2.4/appkeys/{appkey}/schedules
	Create	POST	/tcgb-push/v1.3/apps/{appId}/reservations	/push/v2.4/appkeys/{appkey}/reservations
	View list	GET	/tcgb-push/v1.3/apps/{appId}/reservations	/push/v2.4/appkeys/{appkey}/reservations
	View a single item	GET	/tcgb-push/v1.3/apps/{appId}/reservations/{reservation-id}	/push/v2.4/appkeys/{appkey}/reservations/{reservation-id}
	View sent ones	GET	/tcgb-push/v1.3/apps/{appId}/reservations/{reservation-id}/messages	/push/v2.4/appkeys/{appkey}/reservations/{reservation-id}/messages
	Modify	PUT	/tcgb-push/v1.3/apps/{appId}/reservations/{reservationId}	/push/v2.4/appkeys/{appkey}/reservations/{reservationId}
	Delete	DELETE	/tcgb-push/v1.3/apps/{appId}/reservations	/push/v2.4/appkeys/{appkey}/reservations

For more information of the API, click the following link. To find out about the Push API spec mapped with Gamebase Wrapping API, see the following guide. Use the Gamebase AppId and SecretKey to call the Gamebase Wrapping Push API without setting the Push Appkey.

[Notes 1] User can use the gamebase userId value for the uid value exists in Push guide. When registering push token in client SDK, the user identifier is registered as gamebase userId. When a single user allows all push notifications on multiple devices, the user will receive all pushes on multiple devices.

[Notes 2] When you send a push message with an API, the send history cannot be checked from Push > Send History on the Gamebase console. You can find the history in the Log & Crash settings from Push > Settings > Save Send History. Push Guide

Get Subscriptions Status

Queries the current status of subscriptions.

[Method, URI]

Method	URI
POST	/tcgb-inapp/v1.3/apps/{appId}/subscriptions/status

[Request Header]

Check for common items

[Path Variable]

Name	Type	Value
appId	String	NHN Cloud project ID

[Request Parameter]

None

[Request Body]

{
  "payments": [
    {
      "paymentSeq": "2023082410408370",
      "accessToken": "Yk3sMxc-JSaGLLY0X-DnajXDyMXRVjxSRks0Lk1SaoaO7RD7VRjZcs8OTm8lOQVFoP71pgjAb_INjl0Y5KN8_A"
    },
    {
      "paymentSeq": "2023082410408383",
      "accessToken": "qEP1ZeV_ORmJdlNr9xDm9DXDyMXRVjxSRks0Lk1SaoaPiqPX4dG6UstXeWUt1NujyQAwH8BWQJueaPRfmnRyeg"
    }
  ]
}

Name	Type	Required	Value
payments	Array[Object]	Subscription payment information. Up to 10 can be entered
payments[].paymentSeq	String	Required	Payment number
payments[].accessToken	String	Required	Payment authentication token

[Response Body]

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "result": [
    {
      "userId": "QXG774PMRZMWR3BR",
      "paymentSeq": "2023082410408389",
      "accessToken": "uddRuwkHm9nFIHjvVuDS2jXDyMXRVjxSRks0Lk1SaoaPiqPX4dG6UstXeWUt1NujyQAwH8BWQJueaPRfmnRyeg",
      "paymentId": "GPA.3333-7714-3477-48799..5",
      "originalPaymentId": "GPA.3333-7714-3477-48799",
      "purchaseTime": "2022-05-16T09:59:27+09:00",
      "expiryTime": "2023-08-24T12:48:45+09:00",
      "renewTime": "2023-08-24T12:48:45+09:00",
      "referenceStatus": "REPURCHASED"
    },
    {
      "userId": "QXG774PMRZMWR3BR",
      "paymentSeq": "2023082410408381",
      "accessToken": "SFkxJL2sk8NlbsPe8ivVGDXDyMXRVjxSRks0Lk1SaoaO7RD7VRjZcs8OTm8lOQVFoP71pgjAb_INjl0Y5KN8_A",
      "paymentId": "GPA.3395-4426-6912-10820..5",
      "originalPaymentId": "GPA.3395-4426-6912-10820",
      "purchaseTime": "2022-05-16T09:59:27+09:00",
      "expiryTime": "2023-08-24T12:48:45+09:00",
      "renewTime": "2023-08-24T12:48:45+09:00",
      "referenceStatus": "EXPIRED"
    }
  ]
}

Key	Type	Description
result	Array[Object]	Payment basic information
result[].userId	String	User ID
result[].paymentSeq	String	Payment number
result[].accessToken	String	Payment authentication token
result[].paymentId	String	Recently updated store payment ID
result[].originalPaymentId	String	Initial store payment ID
result[].purchaseTime	String	Recently updated time
result[].expiryTime	String	When subscription expires
result[].renewTime	String	When RENEWED/RECOVERED occurs
result[].referenceStatus	String	Payment Reference Status provided by payment system (in-app purchase in stores, external payment) Currently only available in Google Play Store

[Error Code]

Error Code

Example of API Call

POST https://api-gamebase.nhncloudservice.com/tcgb-push/v1.3/apps/{appId}/messages

Content-Type: application/json
X-TCGB-Transaction-Id: 88a1ae42-6b1d-48c8-894e-54e97aca07fq
X-Secret-Key: IgsaAP

{
    "target" : {
        "type" : "UID",
        "to": ["gamebase userId-1", "gamebase userId-2"]
    },
    "content" : {
        "default" : {
            "title": "title",
            "body": "body"
        }
    },
    "messageType" : "AD",
    "contact": "1588-1588",
    "removeGuide": "Menu > Setting",
    "timeToLiveMinute": 1,
    "provisionedResourceId": "id",
    "adWordPosition": "TITLE"
}

Others

OS Code

The code defined internally by Gamebase for the OS of the user device.

Code	Description
AOS	Android
IOS	iOS
WEB	Web
WINDOWS	Windows

Store Code

The code defined internally by Gamebase for the store where the app is installed.

Code	Description
GG	Google Play Store
AS	App Store
ONESTORE	ONE store
GALAXY	Galaxy Store
AMAZON	Amazon Appstore
HUAWEI	Huawei AppGallery
MYCARD	Global MyCard

Identity Provider Code

The code defined internally by Gamebase for the Identity Providers used for user authentication.

• guest
• google
• facebook
• appleid
• iosgamecenter
• payco
• hangame
• twitter
• naver
• line
• kakaogame
• weibo
  

Member Valid Code

The code defined internally by Gamebase for the user's current status.

Code	Description
Y	Normal user
D	Withdrawn user
B	Banned user
T	Withdrawal-suspended user
P	Ban-suspended user
M	Missing account

Store Reference Status

Payment reference status provided by the payment system (in-app purchase in stores, external payment)

Payment System	Code	Description
Google In-App	PURCHASED	Purchase complete
	REPURCHASED	Repurchase complete
	RESTARTED	Subscription restarted
	PENDING	Payment pending
	RENEWED	Subscription renewed
	RECOVERED	Subscription recovered
	PAUSE_SCHEDULED	Subscription to be paused
	PAUSED	Paused
	REVOKED	Refunded
	CANCELED_PRODUCT	Single item payment canceled
	CANCELED_SUBSCRIPTION	Subscription canceled (renewal stopped) - Current subscription must be provided
	ON_HOLD	On hold
	IN_GRACE	In grace period
	EXPIRED	Expired
	NOT_APPOINTED	No corresponding condition

Support

To inquire about causes of failure in API call, upload API call URL (with HTTP body, if available) along with response results to Customer Center, and we'll respond as soon as possible.

Example of API Call

GET https://api-gamebase.nhncloudservice.com/tcgb-launching/v1.3/apps/C3JmSctU/maintenances/under-maintenance

Result of Failed API Response

{
    "header": {
        "transactionId": "18a1ae42-6b1d-54c8-894e-54e97bca07fq",
        "resultCode": -4010002,
        "resultMessage": "Gamebase product appKey is invalid, appId:C3JmSctU",
        "traceError": {
            "trackingTime": 1489726350287,
            "throwPoint": "gateway",
            "uri": "/tcgb-launching/v1.3/apps/C3JmSctU/maintenances/under-maintenance"
        },
        "isSuccessful": false
    }
}