1.概要

Rank API は、指定されたランキングの上位x名の順位情報を取り扱います（デフォルト10名）。
同時に、指定されたランキングにおけるユーザーの順位情報を取得します。

2.オブジェクトフィールド
2.1 Rank

パラメータ	内容	型
id	ユーザーID	string
nickname	ユーザーのニックネーム	string
rank	順位	int
score	スコア	int

3.リクエスト

3.1 エンドポイント

http://gpf-api.[対象ドメイン]/social/rank/{uid}/{rankingkey}

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 テンプレートパラメータ

uid（必須）

パラメータ	内容
@me	呼び出しユーザー

rankingkey（必須）

パラメータ	内容
{rankingkey}	指定するランキングのKEY

3.5 クエリパラメータ
format

パラメータ	内容	備考
json	“application/json;charset=utf8”	デフォルトでセットされます。

startIndex

パラメータ	内容	備考
任意の自然数	取得するランキング情報の開始値

count

パラメータ	内容	備考
任意の自然数	最大取得件数	未指定時 10

4.レスポンス

HTTPメソッド	レスポンスコード	内容
GET	200	データ取得正常終了
GET	400	リクエスト不正
GET	401	認証失敗
POST/PUT/DELETE	403	許可されていないメソッド
GET	404	存在しないデータ
GET	500	プラットフォームエラー

X.サンプル

ニックネームが設定されていないユーザーは、nicknameを”未設定”で返します。

X.1 ランキングの上位10名の順位情報と自身の順位情報を取得する

【リクエスト】
/social/ranking/@me/test_ranking
【レスポンス】
{
    "entry":[
        {
            "id":"1151252574aa51f2e1a12ea485818043dc35abea3591ca14240f1f9a6b698018",
            "nickname":"会員A",
            "rank":1,
            "score":70
        },
        {
            "id":"11512525748931a2399a7e9663705b0bc49a605112b4b47b5f286f3a88cda02a",
            "nickname":"未設定",
            "rank":2,
            "score":69
        },
        (以下、10位までの情報が続きます)
    ],
    "self":[
        {
            "id":"1151252574d38086af8ebd0c62714eeb34d2db21a0a9520417aff08c339f5b9f",
            "nickname":"会員ガラケー",
            "rank":296,
            "score":350
        }
    ],
    "itemsPerPage":10,
    "startIndex":0,
    "totalResults":11
}

X.2 ランキングの上位5名の順位情報と自身の順位情報を取得する

【リクエスト】
/social/ranking/@me/test_ranking2?count=5
【レスポンス】
{
    "entry":[
        {
            "id":"1151252574aa51f2e1a12ea485818043dc35abea3591ca14240f1f9a6b698018",
            "nickname":"会員A",
            "rank":1,
            "score":70
        },
        {
            "id":"11512525748931a2399a7e9663705b0bc49a605112b4b47bbfe8a6cce4b2a02a",
            "nickname":"覇者",
            "rank":2,
            "score":69
        },
        (以下、5位までの情報が続きます)
    ],
    "self":[
        {
            "id":"1151252574d38086af8ebd0c62714eeb34d2db21a0a9520417aff08c339f5b9f",
            "nickname":"会員ガラケー",
            "rank":null,
            "score":null
        }
    ],
    "itemsPerPage":5,
    "startIndex":0,
    "totalResults":6
}