1.概要
RankingJoin API は、指定したランキングへの参加状況を確認し、未参加であれば強制的に参加させます。
2.オブジェクトフィールド
2.1 Ranking
| パラメータ | 内容 | 型 |
| rankingKey | ランキングKEY | string |
3.リクエスト
3.1 エンドポイント
http://gpf-api.[対象ドメイン]/social/rankingJoin/
3.2 HTTPメソッド
| HTTPメソッド | 機能 |
| GET | – |
| PUT | – |
| POST | ランキングへの参加登録 |
| DELETE | – |
3.3 認証
HTTPヘッダーに以下の値を設定してください。全て必須項目です。
| キー | 値 |
| Authorization | 呼び出しユーザーのsapkeyを指定 |
| GAME_CODE | 利用ゲームのGAME_CODE |
| Hash | SHA1(Authorizaion + GAME_CODE + API_KEY) |
3.4 クエリパラメータ
format
| パラメータ | 内容 | 備考 |
| json | “application/json;charset=utf8” | デフォルトでセットされます。 |
rankingKey（必須）
| パラメータ | 内容 |
| 任意の文字列 | 強制参加させるランキングに指定したランキングKEY |
4.レスポンス
| HTTPメソッド | レスポンスコード | 内容 |
| POST | 201 | データ登録正常終了 |
| POST | 400 | リクエスト不正 |
| POST | 401 | 認証失敗 |
| GET/PUT/DELETE | 403 | 許可されていないメソッド |
| POST | 404 | 存在しないデータ |
| POST | 500 | プラットフォームエラー |
X.サンプル
X.1 ランキングに強制参加させる
| リクエスト | http://gpf-api.ymdunisys.jp/social/rankingJoin/ |
| JSON | { “rankingKey”:”TESTRANKING1″ } |
| HTTPヘッダ内「Authorization」のユーザーがrankingkeyのランキング参加しているかを確認後、 参加していない場合は強制参加させます。(参加済みの場合は特に処理を行いません) ※両パターンとも、正常終了時はレスポンスコード201を返します |
|