ヤマダゲームコイン残高取得 API

1.概要

指定ユーザーのヤマダゲームコイン残高の取得を行います。
※ゲスト会員（2024年2月追加予定）の場合、当APIは各項目は0が設定されます。

2.リクエスト

2.1 エンドポイント

http://gpf-api.[対象ドメイン]/api/balance

2.2 HTTPメソッド

HTTPメソッド 機能
GET –
PUT –
POST 指定ユーザーのゲームコイン残高取得を行う
DELETE –

2.3 クエリパラメータ

uuid（必須）

フォーマット 内容 備考
半角英数 ユーザーを特定する識別キー 認証APIで取得した値

game_code（必須）

フォーマット 内容 備考
半角英数 ゲームを特定する為のコード GAME_CODEはゲーム追加申請時にお知らせする値になります。

hash（必須）

フォーマット 内容 備考
半角英数 データ改竄防止のためのハッシュキー SHA1(uuid + game_code + api_key(ゲーム追加申請時にお知らせする値))

3.レスポンス

パラメータ 内容 フォーマット
status_code 処理結果のステータスコード 数字
status_msg ステータスメッセージ 文字列
balance ヤマダゲームコイン残高(総計) 数字
coin ヤマダゲームコイン残高(有料コイン) 数字
free_coin ヤマダゲームコイン残高(無料コイン) 数字

X.サンプル

X.1 ヤマダゲームコイン残高取得成功後のレスポンス

{
    "status_code":"200",
    "status_msg":"Success",
    "balance":"10000",
    "coin":"8000",
    "free_coin":"2000"
}