1.概要
指定ユーザーにヤマダポイント、若しくはヤマダゲームコイン(無料コイン)をログインボーナスとして加算します。
※対象ユーザーがゲーム会員の場合、ヤマダゲームコイン(無料コイン)を加算します。
※ゲスト会員(2024年2月追加予定)に当APIは利用できません。
2.リクエスト
2.1 エンドポイント
http://gpf-api.[対象ドメイン]/api/loginBonus
2.2 HTTPメソッド
| HTTPメソッド | 機能 |
| GET | – |
| PUT | – |
| POST | 指定ユーザーにヤマダポイント、 若しくはヤマダゲームコインを付与する。 |
| DELETE | – |
2.3 クエリパラメータ
sap_key(必須)
| フォーマット | 内容 | 備考 |
| 半角英数 | ユーザーを特定する識別キー |
game_code(必須)
| フォーマット | 内容 | 備考 |
| 半角英数記号 | ゲームを特定する為のコード | GAME_CODEはゲーム追加申請時にお知らせする値になります。 |
add_type(必須)
| フォーマット | 内容 | 備考 |
| 数字 | 1:ヤマダポイント 2:ヤマダゲームコイン(無料コイン) |
付与する項目を半角数字で指定します。 |
point(必須)
| フォーマット | 内容 | 備考 |
| 数字 | 付与するポイント(ゲームコイン)数 | 付与できるヤマダポイント数は1~10です。 付与できるヤマダゲームコイン数は1~300です。 |
request_no(必須)
| フォーマット | 内容 | 備考 |
| 半角英数記号 | ゲーム側で管理する処理連番 | プラットフォーム内で一意である事 (例:game_code + 日付 + 連番) ※ポイント付与、コイン付与においても一意であること |
hash(必須)
| フォーマット | 内容 | 備考 |
| 半角英数 | データ改竄防止のためのハッシュキー | SHA1(sap_key+ game_code + add_type + point + request_no + api_key(ゲーム追加申請時にお知らせする値)) |
3.レスポンス
| フォーマット | 内容 | 備考 |
| status_code | 処理結果のステータスコード | 数字 |
| status_msg | ステータスメッセージ | 文字列 |
| add_type | 1:ヤマダポイント 2:ヤマダゲームコイン(無料コイン) |
数字 |
| point_balance | ヤマダポイント残高 ※add_typeが1の場合のみ表示 |
数字 |
| coin_balance | ヤマダゲームコイン残高(総計) ※add_typeが2の場合のみ表示 |
数字 |
| coin | ヤマダゲームコイン残高(有料コイン) ※add_typeが2の場合のみ表示 |
数字 |
| free_coin | ヤマダゲームコイン残高(無料コイン) ※add_typeが2の場合のみ表示 |
数字 |
| transaction_no | プラットフォーム側の処理通番 | 数字 |
X.サンプル
X.1 ヤマダモバイル会員にヤマダポイント付与完了後のレスポンス
{
"status_code":"200",
"status_msg":"Success",
"add_type":1,
"point_balance":1000,
"transaction_no":123456789
}
X.2 ヤマダモバイル会員にヤマダゲームコイン付与、若しくはヤマダゲーム会員に付与完了後のレスポンス
{
"status_code":"200",
"status_msg":"Success",
"add_type":2,
"coin_balance":5000 ,
"coin":1000 ,
"free_coin":4000 ,
"transaction_no":123456789
}