1.概要
Score API は、ゲーム結果(スコア)に基づいてユーザーが参加しているランキングのスコアデータを更新します。(ユーザーはランキングに参加した時点でスコア0のデータを保持しています。)
2.リクエスト
2.1 エンドポイント
http://gpf-api.[対象ドメイン]/social/score/{uid}/{selector}
2.2 HTTPメソッド
| HTTPメソッド |
機能 |
| GET |
– |
| PUT |
スコアの更新 |
| POST |
– |
| DELETE |
– |
2.3 認証
HTTPヘッダーに以下の値を設定してください。全て必須項目です。
| キー |
値 |
| Authorization |
呼び出しユーザーのsapkeyを指定 |
| GAME_CODE |
利用ゲームのGAME_CODE |
| Hash |
SHA1(Authorizaion + GAME_CODE + API_KEY) |
2.4 テンプレートパラメータ
uid（必須）
selector（何れか必須）
| パラメータ |
内容 |
| @format |
スコア形式KEYで登録先を指定 |
| @ranking |
ランキングKEYで登録先を指定 |
2.5 クエリパラメータ
format
| パラメータ |
内容 |
備考 |
| json |
“application/json;charset=utf8” |
デフォルトでセットされます。 |
score（必須）
| パラメータ |
内容 |
備考 |
| 任意の整数 |
データベースへ登録するスコア |
|
uniqueid（必須）
| パラメータ |
内容 |
備考 |
| 任意の文字列 |
ユニークID（二重送信防止用） |
|
formatkey
| パラメータ |
内容 |
備考 |
| 任意の文字列 |
スコアの形式を指定するKEY |
@format時 必須 |
rankingkey
| パラメータ |
内容 |
備考 |
| 任意の文字列 |
ランキングを指定するKEY |
@ranking時 必須 |
3.レスポンス
| HTTPメソッド |
レスポンスコード |
内容 |
| PUT |
201 |
データ更新正常終了 |
| PUT |
400 |
リクエスト不正 |
| PUT |
401 |
認証失敗 |
| GET/POST/DELETE |
403 |
許可されていないメソッド |
| PUT |
404 |
存在しないデータ |
| PUT |
500 |
プラットフォームエラー |
備考
スコアを登録する際、selector”@ranking”時は rankingkey, Authorization で、selector”@format”時は formatkey, GAME_CODE, Authorization で、ユーザーの参加ランキングを特定します。
X.サンプル
“uniqueid”はスコア登録と同時にデータベースに記録され、uniqueidが重複した場合(二重送信時)、レスポンスコード400を返します。
X.1 formatkeyを指定してスコアを送信する
| リクエスト |
http://gpf-api.ymdunisys.jp/social/score/@me/@format |
| JSON |
{“rankingkey”:””,”formatkey”:”ITEM”,”score”:”20″,”uniqueid”:”test01″} |
| 備考 |
指定されたランキングが開催期間中でない場合、またはユーザーが未参加の場合、レスポンスコード404を返します。
scoreに値がない、またはscoreが整数値でない場合、レスポンスコード400を返します。 |
X.2 rankingkeyを指定してスコアを送信する
| リクエスト |
http://gpf-api.ymdunisys.jp/social/score/@me/@ranking |
| JSON |
{“rankingkey”:”test_ranking”,”formatkey”:””,”score”:”10000″,”uniqueid”:”send-1″} |
| 備考 |
指定されたランキングが開催期間中でない場合、またはユーザーが未参加の場合、レスポンスコード404を返します。
scoreに値がない、またはscoreが整数値でない場合、レスポンスコード400を返します。 |
