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

個人情報の取得

指定されたユーザの個人情報を取得します。

GET /api/profile
備考

ログインプロバイダ別に取得可能な個人情報は こちらのページ でご確認ください。

リクエストパラメータ​

パラメータ名型必須説明
keystring○API キー
identifierstring△対象のソーシャルPLUS ID
primary_keystring△対象のお客様サービス側ユーザID
delete_profilebooleantrue の場合、API 呼び出し後にソーシャルPLUS 側に保存している個人情報を削除します
注記

delete_profile が true の場合でも、次回ログイン時には再度個人情報が取得されます。

恒久的に個人情報を取得しないようにするには 個人情報の削除（delete_profile）API を利用して「個人情報取得禁止の状態」を有効化する必要があります。

エラーコード​

HTTP StatusCodeMessage説明
4011Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
4005Required parameter not found.必須のパラメーターが指定されていません
4006Invalid parameter.パラメーターに間違いがあります
4047Entity not found.指定されたユーザが存在しません

レスポンス​

キー型最大長説明
statusstring15リクエストが成功したかどうか（ok または failed）
userobject-User オブジェクト 参照
profileobject-Profile オブジェクト 参照
followobject-Follow オブジェクト 参照
emailarray of object-Email オブジェクト 参照
phonearray of object-Phone オブジェクト 参照

User オブジェクト​

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

Profile オブジェクト​

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

Follow オブジェクト​

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

Email オブジェクト​

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

Phone オブジェクト​

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

レスポンス例​

{
  "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,
  },
  "profile":{
    "uri": [],
    "first_name": "太郎",
    "first_name_kana": "タロウ",
    "first_name_kanji": "太郎",
    "middle_name": null,
    "middle_name_kana": null,
    "middle_name_kanji": null,
    "last_name": "鈴木",
    "last_name_kana": "スズキ",
    "last_name_kanji": "鈴木",
    "full_name": "鈴木太郎",
    "full_name_kana": "スズキタロウ",
    "full_name_kanji": "鈴木太郎",
    "user_name": null,
    "verified": null,
    "image_url": "https://scontent-nrt1-1.xx.fbcdn.net/v/.../1114723111_n.jpg",
    "age_range_max": 17, 
    "age_range_min": 13,
    "birthday": "2006-03-23",
    "gender": 1,
    "relationship_status": 4,
    "blood_type": null,
    "bio": "よろしくお願いします。",
    "quotes": null,
    "website": [
      "https://www.feedforce.jp/",
      "https://socialplus.jp/"
    ],
    "graduated_school": null,
    "graduated_school_type": null,
    "graduated_year": null,
    "graduated_concentration": null,
    "job_company": null,
    "job_position": null,
    "location": "東京都文京区小石川１－２－１出光後楽園ビル５Ｆ",
    "location_id": null,
    "location_jis_id": 13105,
    "hometown": null,
    "hometown_id": null,
    "hometown_jis_id": null,
    "postal_code": "1130034",
    "prefecture": "東京都",
    "city": "文京区",
    "street": "小石川１－２－１出光後楽園ビル５Ｆ",
    "last_updated_at": "2012-04-10T09:42:41Z",
    "update_count": 40
  },
  "email": [
    {
      "email": "test@example.com",
      "verified": false,
      "media_id": "yahoo"
    }
  ],
  "phone": [
    {
      "number": "0312345678",
      "verified": true,
      "type": "phone",
      "media_id": "yahoo"
    }
  ],
  "follow": {
    "followed_by": 0,
    "following": 0
  }
}

実行サンプル​

curl -X GET https://api.socialplus.jp/api/profile -G \
  -d key={API Key} \
  -d primary_key=user_123
に最終更新