1.概要

Trophy API は、ゲーム上で取得したユーザーのトロフィー獲得履歴情報にアクセスします。
指定されたゲームに設定されているトロフィー及びユーザーの取得状況の取得の利用が想定されます。

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

2.1 Trophy

パラメータ	内容	型
id	対象のユーザーID	string
game_code	game_code	string
trophytype	トロフィーの種類(1:ブロンズ、2:シルバー、3:ゴールド、4:レインボー)	integer
trophycode	トロフィーに設定されたコード	string
trophyname	トロフィー名	string
trophyimg	トロフィー用アイコン画像	string
purchase	0:未取得 1:取得済	integer
addtime	取得日時(yyyy/MM/dd HH:mm)	datetime

3.リクエスト

3.1 エンドポイント

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

3.2 HTTPメソッド

HTTPメソッド	機能
GET	ゲームのトロフィー情報及び獲得履歴の取得
PUT	–
POST	トロフィー獲得履歴の登録
DELETE	–

3.3 認証

HTTPヘッダーに以下の値を設定してください。全て必須項目です。

キー	値
Authorization	呼び出しユーザーのsapkeyを指定
GAME_CODE	利用ゲームのGAME_CODE
Hash	SHA1(Authorizaion + GAME_CODE + API_KEY)

2.4 テンプレートパラメータ

uid

パラメータ	内容	備考
@me	呼び出しユーザー	GET時 必須
{uid}	任意のユーザーのsapkey	GET時 必須

4.レスポンス

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

X.サンプル

ユーザーAを指定するには、AuthorizationがユーザーAのsapkeyである必要があります。

X.1 ユーザーAのGAME_CODEに該当するゲームのトロフィー取得状況を取得する

【リクエスト】
/social/trophy/@me
【レスポンス】
{
    "entry":[
        {
            "addtime":null,
            "game_code":"GAME_CODE7",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "purchase":"0",
            "trophycode":"TEST_CODE1",
            "trophyimg":"testimg1",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績１",
            "trophytype":"1"
        },
        {
            "addtime":"2013/06/10 10:34",
            "game_code":"GAME_CODE7",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "purchase":"1",
            "trophycode":"TEST_CODE4",
            "trophyimg":"testimg4",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績４",
            "trophytype":"1"
        },
        {
            "addtime":"2013/06/10 21:48",
            "game_code":"GAME_CODE7",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "purchase":"1",
            "trophycode":"TEST_CODE2",
            "trophyimg":"testimg2",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績２",
            "trophytype":"2"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":3
}

X.2 指定したユーザーのGAME_CODEに該当するゲームのトロフィー取得状況を取得する

【リクエスト】
/social/trophy/115125257407c4a8116ade1dee6df4f99b402f69bad733184c50fe313e100ad3
【レスポンス】
{
    "entry":[
        {
            "addtime":null,
            "game_code":"GAME_CODE7",
            "id":"115125257407c4a8116ade1dee6df4f99b402f69bad733184c50fe313e100ad3",
            "purchase":"0",
            "trophycode":"TEST_CODE1",
            "trophyimg":"testimg1",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績１",
            "trophytype":"2"
        },
        {
            "addtime":null,
            "game_code":"GAME_CODE7",
            "id":"115125257407c4a8116ade1dee6df4f99b402f69bad733184c50fe313e100ad3",
            "purchase":"0",
            "trophycode":"TEST_CODE4",
            "trophyimg":"testimg4",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績４",
            "trophytype":"2"
        },
        {
            "addtime":null,
            "game_code":"GAME_CODE7",
            "id":"115125257407c4a8116ade1dee6df4f99b402f69bad733184c50fe313e100ad3",
            "purchase":"0",
            "trophycode":"TEST_CODE2",
            "trophyimg":"testimg2",
            "trophyname":"戦国学園KABUKIテストＦＰ_実績２",
            "trophytype":"2"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":3
}

X.3 ユーザーAの指定したトロフィー獲得情報を登録する

リクエスト	http://gpf-api.ymdunisys.jp/social/trophy/
JSON	{“trophycode”:”トロフィーに設定されているトロフィーコード”}
備考	trophycodeにはHTTPヘッダーの「GAME_CODE」で指定されたゲームに設定されているトロフィーコードを指定してください。 存在しないトロフィー、または既に取得したトロフィーの獲得履歴を登録された場合、レスポンスコード400を返します。