ログインプロバイダごとの個人情報の取得
指定されたユーザの、指定されたログインプロバイダから得た個人情報を取得します。
個人情報の取得(profile)API と異なり、各ログインプロバイダから取得した個人情報を、ログインプロバイダごとに取得できます。
GET /api/profile_from_providers
備考
ログインプロバイダ別に取得可能な個人情報は こちらのページ でご確認ください。
リクエストパラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
key | string | ○ | API キー |
identifier | string | △ | 対象のソーシャルPLUS ID |
primary_key | string | △ | 対象のお客様サービス側ユーザID |
target_provider | string | ○ | 対象のログインプロバイダ。, 区切りで複数指定可能 |
注記
ユーザが未連携のログインプロバイダを指定した場合でもエラーにはならず、ログインプロバイダごとの結果が空のオブジェクトで返ります。レスポンス例 もご参照ください。
エラーコード
HTTP Status | Code | Message | 説明 |
---|---|---|---|
401 | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
400 | 5 | Required parameter not found. | 必須のパラメーターが指定されていません |
400 | 6 | Invalid parameter. | パラメーターに間違いがあります |
404 | 7 | Entity not found. | 指定されたユーザが存在しません |
レスポンス
キー | 型 | 最大長 | 説明 |
---|---|---|---|
status | string | 15 | リクエストが成功したかどうか(ok または failed ) |
{ログインプロバイダ} | object | - | キーはログインプロバイダになります。オブジェクトの構造は ログインプロバイダ オブジェクト 参照 |
ログインプロバイダ オブジェクト
キー | 型 | 最大長 | 説明 |
---|---|---|---|
profile | object | - | Profile オブジェクト 参照 |
follow | object | - | Follow オブジェクト 参照 |
array of object | - | Email オブジェクト 参照 | |
phone | array of object | - | Phone オブジェクト 参照 |
Profile オブジェクト
共通: Profile オブジェクト を参照してください。
Follow オブジェクト
共通: Follow オブジェクト を参照してください。
Email オブジェクト
共通: Email オブジェクト を参照してください。
Phone オブジェクト
共通: Phone オブジェクト を参照してください。
レスポンス例
{
"status": "ok",
"facebook": {
"profile": {
"first_name": "太郎",
"first_name_kanji": null,
"middle_name": null,
"last_name": "鈴木",
"last_name_kanji": null,
"full_name": "鈴木 太郎",
"full_name_kanji": null,
"gender": null,
"birthday": null,
"location": null,
"location_id": null,
"location_jis_id": null,
"hometown": null,
"hometown_id": null,
"hometown_jis_id": null,
"uri": null,
"image_url": "https://scontent-nrt1-1.xx.fbcdn.net/.../1114723111_n.jpg"
},
"follow": {
"followed_by": 0,
"following": 0
},
"email": [
{
"email": "test@example.com"
}
]
},
"twitter": {},
"yahoo": {
"profile": {
"first_name": "太郎",
"first_name_kana": "タロウ",
"first_name_kanji": "太郎",
"last_name": "鈴木",
"last_name_kana": "スズキ",
"last_name_kanji": "鈴木",
"full_name": "鈴木太郎",
"full_name_kana": "スズキタロウ",
"full_name_kanji": "鈴木太郎",
"gender": 2,
"birthday": "2006-03-01",
"location": "東京都文京区小石川1-2-1出光後楽園ビル5F",
"location_jis_id": 13105,
"postal_code": "1120002",
"prefecture": "東京都",
"city": "文京区",
"street": "小石川1-2-1出光後楽園ビル5F"
},
"email": [
{
"email": "test@example.com"
}
],
"phone": [
{
"number": "0312345678"
}
]
},
"line": {
"profile":{
"user_name": "awesome-user",
"image_url": "https://profile.line-scdn.net/51ehk...sYH5G",
"bio": "よろしくお願いします。",
"gender": null,
"birthday": null,
"location": null,
"prefecture": null,
"city": null,
"street": null,
"postal_code": null,
"first_name": null,
"first_name_kana": null,
"last_name": null,
"last_name_kana": null,
"middle_name": null,
"full_name": null,
"friendship_status": true,
"friendship_status_updated_at": "2021-07-05T08:36:51Z"
},
"email": [],
"phone": []
}
}
実行サンプル
curl -X GET https://api.socialplus.jp/api/profile_from_providers -G \
-d key={API Key} \
-d primary_key=user_123 \
-d target_provider=facebook,twitter,yahoo,line