1.概要

ゲームプラットフォーム上で発行されたトークン情報を取り扱います。

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

2.1 Token

パラメータ	内容	型
sapkey	発行したトークンの対象ユーザーsapkey	string
nickname	対象ユーザーのニックネーム	string
guest	ゲスト会員であるかどうか ※ゲストプレイ可能ゲームの場合のみ出力	boolean
sapkeyOld	移行済みユーザーの場合、移行前のsapkey ※ゲストプレイ可能ゲームの場合のみ出力	string

移行：ゲストプレイを行ったブラウザにて新規会員登録を行った場合、
ゲストプレイ時に発行されたsapkeyは新規登録時に発行されたsapkeyに上書きされ、
元のsapkeyはsapkeyOldに保存されます。
sapkeyOldは一度設定されると消える事は無く、更新される事もありません。
　sapkeyOldが検出された場合、ゲーム側ではユーザーの移行処理をお願い致します。

3.リクエスト

3.1 エンドポイント

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

3.2 HTTPメソッド

HTTPメソッド	機能
GET	トークン対象ユーザーの取得
PUT	–
POST	–
DELETE	–

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

キー	値
GAME_CODE	利用ゲームのGAME_CODE

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

token（必須）

パラメータ	内容
発行されたトークン	指定したトークン

3.レスポンス

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

X-1.サンプル

X-1.1 有効期限内の未使用のトークンからユーザー情報を取得する

有効期限は、発行されてからゲームプラットフォーム側で指定された秒数までとなります。
トークンが発行されるタイミングは、ゲームプラットフォームからゲームの方に遷移する直前になります。
当APIでユーザー情報を取得すると、該当トークンは使用済となります。

【リクエスト】
 /social/token/52956abc3d6a5e22c6904a7c474a69c9f2bc5fb5
【レスポンス】
{
    "entry": [
        {
            "sapkey":"1151252574df867cbf9afb972b4a6d9ecacf37f950c3d60e4e9852ff6da9600e",
            "nickname":"エーユージクス2",
            "guest":false,
            "sapkeyOld":"123131231231312312"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":1
}

X-1.2 存在しないトークン、または有効期限切れ、もしくは使用済みのトークンを指定した場合

【リクエスト】
 /social/token/52956abc3d6a5e22c6904a7c474a69c9f2bc5fb5
【レスポンス】
{
    "entry": [],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":0
}

X-2.トークン発行方法

以下の方法でトークンを発行する事ができます。

X-2.1 ゲーム詳細画面において、「プレイ」「ゲームを始める」「ゲストプレイ」押下時

この場合、各ゲームに指定されているURLの後ろに「token=[発行したトークン]」を付与して指定URLに遷移します。
トークン認証が「利用する」に設定されているゲームのみが利用可能です。

X-2.2 URLから直接入力

下記URLを直接入力してトークンを発行する事もできます。

　`http://gpf.[対象ドメイン]/token/create?return_url=[利用ゲームのURL]&game_code=[利用ゲームのGAME_CODE]`

ログイン成功後、return_urlに指定したURLの後ろに「token=[発行したトークン]」を付与して指定URLにリダイレクトします。
※指定URLが無い場合はゲームプラットフォームのトップページへリダイレクトします。

YAMADA GAME Developer Center

TokenAPI