1.概要

指定ユーザーのヤマダゲームコインの現在の残高、
及び指定された減算コイン数を減算後の残高を取得します。
※ゲスト会員に当APIは利用できません。

2.リクエスト

2.1 エンドポイント

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

2.2 HTTPメソッド

HTTPメソッド	機能
GET	–
PUT	–
POST	現在の各コイン残高、 及び指定された減算コイン数減算後の残高取得を行う
DELETE	–

2.3 クエリパラメータ

uuid（必須）

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

game_code（必須）

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

coin（必須）

フォーマット	内容	備考
数字	減算するゲームコイン数	0以上を指定します。 0の場合、減算前、減算後の内容は同じになります。

kind（必須）

フォーマット	内容	備考
数字	0：指定なし 1：無料コインでのみ減算 2：有料コインでのみ減算	0はタイトル限定コインから先に減算し、足りない場合は有料・無料コインから減算します。

hash（必須）

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

3.レスポンス

【注意】：不足が発生する場合、after_から始まる項目は全て返却されません

パラメータ	内容	フォーマット
status_code	処理結果のステータスコード	数字
status_msg	ステータスメッセージ	文字列
before_coin	減算前ヤマダゲームコイン（有料コイン）	数字
before_free_coin	減算前ヤマダゲームコイン(無料コイン)	数字
before_title_coin	減算前ヤマダゲームコイン(タイトル限定コイン)	数字
after_coin	減算後ヤマダゲームコイン(有料コイン)	数字
after_free_coin	減算後ヤマダゲームコイン(無料コイン)	数字
after_title_coin	減算後ヤマダゲームコイン(タイトル限定コイン)	数字

X.サンプル

X.1 減算予定取得完了後のレスポンス（coin:1000、kind:0）

{
    "status_code":"200",
    "status_msg":"Success",
    "before_coin":"500",
    "before_free_coin":"500",
    "before_title_coin":"2000", 
    "after_coin":"500",
    "after_free_coin":"500",
    "after_title_coin":"1000"
}

X.2 減算予定取得完了後のレスポンス（coin:1000、kind:1）

{
    "status_code":"200",
    "status_msg":"Success",
    "before_coin":"500",
    "before_free_coin":"500",
    "before_title_coin":"2000", 
    "after_coin":"0",
    "after_free_coin":"0",
    "after_title_coin":"2000"
}

X.3 所持コイン数が減算予定数に満たない場合

{
    "status_code":"200",
    "status_msg":"Success",
    "before_coin":"500",
    "before_free_coin":"500",
    "before_title_coin":"2000",
}