Skip to content

Integration Overview

Overview

Integration Overview

  • The MiraclePlay API is used for specific data such as scores/achievements/various actions within the game through RestFul format WebAPI communication.
  • It is provided to be utilized in various game modes in MiraclePlay.

Integration Structure

  • When game data is stored in the database, MiraclePlay integrates the necessary data for the match using the Join API and GameData API 2.
  • The two APIs required at this time can be provided to MiraclePlay using analytics without the need for separate API construction.

Game Rules

  • Game Modes: There are two modes: Ranking Battle and Tournament Battle.
  • Ranking Battle: Prizes are awarded based on the participants' rankings.
  • Tournament Battle: Individuals/teams battle, and the winners advance to the next round.
  • Aggregation Method: Top score, total score, and average score are aggregated separately for singles and teams.

API Integration Implementation

  • Join API: An API for checking account existence when participating in a game
  • UUID and NickName fields are mandatory
  • If logs are sent to Analytics, the Join API can be replaced with the 'Data Verification' API provided by Analytics
    • You can define a new log in Analytics consisting of UUID and NickName fields, or replace the UUID and NickName information with the playerId and userId fields of the pre-defined 'Content Log'

Join API design example (as of 25.04.07)

Separator Description Purpose Type Composition
UUID Unique ID of the user MiraclePlay matching check POST Required
NickName Call to check existence true/false Check if actually exists in the game POST Required
ClientVer Client version information Match the participant's minimum game version POST Optional
AccessKey AccessKey for data security Additional required field value for API call
(Methods may vary by manufacturer)		 POST Optional
API URL
  • GameData API: An API for recording game results
  • UUID field is mandatory
  • Other fields vary depending on the game and match
  • If logs are sent to Analytics, the GameData API can be replaced with the 'Data Retrieval' API provided by Analytics
    • You can define a new log consisting of UUID and fields required by the API, or replace the UUID information with the playerId field of the pre-defined 'Content Log', and other content-related information can replace the fields required by the GameData API

DataData API design example (as of 25.04.07)

Separator Description Purpose Type Composition
UUID Unique ID of the user MiraclePlay matching check POST Required
NickName - (Use the nickname from MiraclePlay) POST Optional
ClientVer Client version information Version check during participant play POST Optional
Starttime Time the game started (GMT) Aggregation of match results POST Per game
Endtime Time the game ended (GMT) Aggregation of match results POST Per game
Score Recorded result data Aggregation of match results POST Per game
playTime Total play time Aggregation of match results POST Per game
AccessKey AccessKey for data security Additional required input field value during API calls
(Methods may vary for each case)		 POST Optional

Others