ヤマダゲームコイン減算 API

1.概要

指定ユーザーのヤマダゲームコインを減算します。
※ゲスト会員（2024年2月追加予定）に当APIは利用できません。

2.リクエスト

2.1 エンドポイント

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

2.2 HTTPメソッド

HTTPメソッド 機能
GET –
PUT –
POST 指定ユーザーのゲームコインを減算する。
DELETE –

2.3 クエリパラメータ

uuid（必須）

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

game_code（必須）

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

request_no（必須）

フォーマット 内容 備考
半角英数記号 ゲーム側で管理する処理連番 プラットフォーム内で一意である事
(例：game_code + 日付 + 連番)
※ポイント付与、コイン付与においても一意であること

coin（必須）

フォーマット 内容 備考
数字 減算するゲームコイン数 0より大きい値を指定します。
※減算されるコインの種類はユーザーの所持数により変動します

hash（必須）

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

3.レスポンス

パラメータ 内容 フォーマット
status_code 処理結果のステータスコード 数字
status_msg ステータスメッセージ 文字列
balance 減算後のヤマダゲームコイン残高(総計) 数字
use_coin 減算したヤマダゲームコイン(有料コイン) 数字
use_free_coin 減算したヤマダゲームコイン(無料コイン) 数字
coin 減算後のヤマダゲームコイン(有料コイン) 数字
free_coin 減算後のヤマダゲームコイン(無料コイン) 数字
transaction_no プラットフォーム側の処理通番 数字

X.サンプル

X.1 減算完了後のレスポンス

{
    "status_code":"200",
    "status_msg":"Success",
    "balance":"5000",
    "use_coin":"500",
    "use_free_coin":"500",
    "coin":"4000",
    "free_coin":"1000",
    "transaction_no":"1234567890"
}