コンテンツにスキップ

インテグレーション概要

概要

連携概要

  • ミラクルプレイAPIは、ゲーム内のスコア/実績/各種アクションなどの特定データをRestFulフォーマットのWebAPI通信に使用します。
  • ミラクルプレイでさまざまな試合方式で活用できるように提供されます。

統合構造

  • ゲーム内データがデータベースに保存されると、ミラクルプレイはJoin APIとGameData APIの2つを利用して試合に必要なデータを統合します。
  • この時必要な2つのAPIは、アナリティクスを利用して別途APIを構築することなくミラクルプレイに提供できます。

競技ルール

  • 競技方式: ランキングバトル、トーナメントバトルの2つの方式があります。
    • ランキングバトル: 参加者のランキングに応じて賞金を授与
    • トーナメントバトル: 個人/チームとバトルを行い、勝者が次のラウンドに進出
  • 集計方式: トップスコア、トータルスコア、平均スコアをシングル/チーム2つに分けて集計します。

API統合の実装

  • Join API: 競技参加時、アカウントの有無チェックのためのAPI
    • UUID、NickNameフィールドが必須
    • アナリティクスでログを送信すると、アナリティクスが提供する「データ確認」APIでJoin APIに代替可能
      • アナリティクスにUUID、NickNameフィールドで構成された新しいログを定義するか、事前に定義された「コンテンツログ」のplayerId、userIdフィールドでUUID、NickName情報を代替可能

(25.04.07 現在) Join API 設計例

区分 説明 用途 タイプ 構成
UUID 対応ユーザーのユニークID MiraclePlay マッチングチェック POST 必須
NickName 存在有無を true/false で呼び出し 実際のゲーム内に存在するかチェック POST 必須
ClientVer クライアントバージョン情報 参加者のゲーム最小バージョン一致 POST 任意
AccessKey データセキュリティのための AccessKey API呼び出し時に必須入力フィールド値追加
(製造元によって方式が異なる場合があります)		 POST 任意
API URL
  • GameData API: 試合結果を記録するためのAPI
    • UUIDフィールドが必須
    • その他のフィールドはゲームや試合によって異なる
    • アナリティクスでログを送信すると、アナリティクスが提供する「データ照会」APIでGameData APIを代替可能
      • アナリティクスにUUIDとAPIに必要なフィールドで構成された新しいログを定義するか、事前に定義された「コンテンツログ」のplayerIdフィールドでUUID情報を置き換えることができ、その他のコンテンツ関連情報でGameData APIに必要なフィールドを置き換えることが可能

(25.04.07 기준) DataData API 設計例

区分 説明 用途 タイプ 構成
UUID 該当ユーザーのユニークID MiraclePlay マッチングチェック POST 必須
NickName - (ミラクルプレイのニックネーム使用) POST 任意
ClientVer クライアントバージョン情報 参加者のプレイ時バージョンチェック POST 任意
Starttime ゲームを開始した時間 (GMT) 試合結果集計 POST ゲーム別
Endtime ゲームが終了した時間 (GMT) 試合結果集計 POST ゲーム別
Score 記録された結果データ 試合結果集計 POST ゲーム別
playTime 総プレイ時間 試合結果集計 POST ゲーム別
AccessKey データセキュリティのためのAccessKey API呼び出し時必須入力フィールド値追加
(各ケースによって方法が異なる場合があります)		 POST 任意

その他