メインコンテンツまでスキップ

認証対象のソーシャルPLUS ID の取得

ソーシャルログインの完了時に発行されたワンタイムトークンを元に、対象のソーシャルPLUS ID を取得します。

GET /api/authenticated_user
注記

ワンタイムトークンは、認証後にソーシャルPLUS から返ってくるコールバックに token パラメータとして含まれています。

注記

お客様サービス側ユーザID の紐付け（map）API によりお客様サービス側のユーザID が紐付けられている場合は、この API の応答結果にも primary_key としてその値が含まれます。

リクエストパラメータ​

パラメータ名型必須説明
keystring○API キー
tokenstring○ワンタイムトークン
add_profilebooleanソーシャルPLUS ID とともに個人情報も取得します
delete_profilebooleanadd_profile が true であり、このパラメータも true の場合、API 呼び出し後にソーシャルPLUS 側に保存している個人情報を削除します

エラーコード​

HTTP StatusCodeMessage説明
4011Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
4044Invalid authentication token or token not found.ワンタイムトークンが指定されていないか、存在しないワンタイムトークンです
4005Required parameter not found.必須のパラメーターが指定されていません
4006Invalid parameter.パラメーターに間違いがあります

レスポンス​

キー型最大長説明
statusstring15リクエストが成功したかどうか（ok または failed）
userobject-User オブジェクト 参照
注記

add_profile が true の場合は 個人情報の取得（profile）API と同等のレスポンスになります。

User オブジェクト​

共通: User オブジェクト を参照してください。

レスポンス例​

{
  "status": "ok",
  "user": {
    "identifier": "5f8a9b18e6eafc375f756af8d75763d43175a00e", 
    "primary_key": "user_123",
    "mapped_at": "2021-03-14T13:29:28Z",
    "last_logged_in_at": "2021-04-10T09:42:41Z",
    "last_logged_in_provider": "yahoo",
    "login_count": 40,
    "created_at": "2012-04-10T08:19:07Z",
    "profile_prohibited": false,
  }
}

実行サンプル​

curl -X GET https://api.socialplus.jp/api/authenticated_user -G \
  -d key={API Key} \
  -d token=4d32813e59878949411e198e1f7e90f1ec9a4a58
に最終更新