1.概要
指定ユーザーにヤマダゲームコインを加算します。
※ゲスト会員（2024年2月追加予定）に当APIは利用できません。
2.リクエスト
2.1 エンドポイント
http://gpf-api.[対象ドメイン]/api/addCoin
2.2 HTTPメソッド
| HTTPメソッド |
機能 |
| GET |
– |
| PUT |
– |
| POST |
指定ユーザーにゲームコインを付与する。 |
| DELETE |
– |
2.3 クエリパラメータ
sap_key（必須）
| フォーマット |
内容 |
備考 |
| 半角英数 |
ユーザーを特定する識別キー |
|
game_code（必須）
| フォーマット |
内容 |
備考 |
| 半角英数記号 |
ゲームを特定する為のコード |
GAME_CODEはゲーム追加申請時にお知らせする値になります。 |
coin（必須）
| フォーマット |
内容 |
備考 |
| 数字 |
付与する有料ゲームコイン数 |
coin、free_coinのどちらかが0より大きい値である事 |
free_coin（必須）
| フォーマット |
内容 |
備考 |
| 数字 |
付与する無料ゲームコイン数 |
coin、free_coinのどちらかが0より大きい値である事 |
request_no（必須）
| フォーマット |
内容 |
備考 |
| 半角英数記号 |
ゲーム側で管理する処理連番 |
プラットフォーム内で一意である事
(例：game_code + 日付 + 連番)
※ポイント付与、コイン付与においても一意であること |
hash（必須）
| フォーマット |
内容 |
備考 |
| 半角英数 |
データ改竄防止のためのハッシュキー |
SHA1(sap_key+ game_code + coin + free_coin + request_no + api_key(ゲーム追加申請時にお知らせする値))
※title_coinを指定する場合はapi_keyの後ろにtitle_coinの値も追加すること |
title_coin
| フォーマット |
内容 |
備考 |
| 数字 |
付与するタイトル限定コイン数 |
付与する場合、coin、free_coinが両方共0であり、title_coinは0より大きい値である事。
※付与しない場合は未指定でよい
※指定する場合、運営側へ事前連絡すること
|
3.レスポンス
| パラメータ |
内容 |
フォーマット |
| status_code |
処理結果のステータスコード |
数字 |
| status_msg |
ステータスメッセージ |
文字列 |
| balance |
ヤマダゲームコイン残高(総計) |
数字 |
| transaction_no |
プラットフォーム側の処理通番 |
数字 |
X.サンプル
X.1 付与完了後のレスポンス
titile_coin付与時のbalanceは付与したタイトル限定コイン数となる（＝title_coinで指定した値）
{
"status_code":"200",
"status_msg":"Success",
"balance":"10000",
"transaction_no":"1234567890"
}
