page icon

REST API Specification 0.0.1

This API is currently under development, and its specifications are subject to change. We actively incorporate feedback from publishers, so please feel free to submit any requests for improvements or additional features.
Additionally, if a publisher API already exists, we will adjust the specifications as much as possible to align with it. If you have any questions or requests regarding usage, please do not hesitate to contact us.

1. General Specifications

1.1. Overview

  • Host: Specified by the publisher
  • Protocol: HTTPS
  • Character Encoding: UTF-8

1.2. Request Specifications

Request Headers:
KeyValueDescription
authorizationbearer [ACCESS_TOKEN]Authentication information
content-typeapplication/jsonContent type
Request Parameters:
KeyValueDescription
Request Body:
KeyValueDescription

1.3. Successful Response

Response Headers:
KeyValue
HTTP Status200
content-typeapplication/json
Response Body:
KeyValueDescription
result_codePUBxxxxResult code
messagexxxxxxxMessage

1.4. Error Response

Response Headers:
KeyValue
HTTP Status400 or above
content-typeapplication/json
Response Body:
KeyValueDescription
result_codePUBxxxxError code
messagexxxxxxxError message

2. API Endpoints

2.1. Item Purchase Eligibility Check

Confirms whether a specified in-game item is available for purchase by the user.
2.1.1. Request:
Endpoint: /check
Method: GET
Request Parameters:
KeyValueDescription
gameGame IDUnique ID for the game specified by the publisher
userIn-game User IDID of the in-game user making the purchase
itemIn-game Item IDUnique ID for the in-game item specified by the publisher
Sample Request:
GET /check?game=9nuKfGCi&user=XQagx3e6&item=8gvyzdur
2.1.2. Successful Response:
Response Headers:
KeyValue
HTTP Status200
content-typeapplication/json
Response Body Examples:
result_codemessageDescription
PUB0000OKThe requested item is available for purchase.
PUB2003Item ID '${item}' cannot be purchased.The item is restricted by the publisher.
PUB2004Item ID '${item}' does not meet purchase criteria.The user does not meet the conditions for purchase.

2.2. Registering Item Purchase Records

Registers the purchase record for a specified in-game item by the user.
2.2.1. Request:
Endpoint: /register
Method: POST
Request Parameters:
KeyValueDescription
gameGame IDUnique ID for the game specified by the publisher
userIn-game User IDID of the in-game user making the purchase
itemIn-game Item IDUnique ID for the in-game item specified by the publisher
Sample Request:
POST /register?game=9nuKfGCi&user=XQagx3e6&item=8gvyzdur
2.2.2. Successful Response:
Response Headers:
KeyValue
HTTP Status200
content-typeapplication/json
Response Body Example:
result_codemessageDescription
PUB0000OKThe purchase record has been successfully registered.