ソーシャルPLUS ユーザの統合
2つのソーシャルPLUS ユーザーを、1ユーザーに統合します。
GET /api/merge_user
統合元と統合先
(A) 統合元のソーシャルPLUS ユーザ source_*
(B) 統合先のソーシャルPLUS ユーザ dest_*
この場合、ユーザの統合後はユーザ (A) が削除され、ユーザ (B) が残ります。
ユーザ (A) は ユーザの削除(delete_user)API で処理した場合と同様に、当該のソーシャルPLUS ID が破棄され、認証情報や個人情報、これまでのログイン履歴もすべて参照できなくなります。
リクエスト
Path パラメーター
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
key | string | ○ | API キー |
source_identifier | string | ※ | 統合元のソーシャルPLUS UID |
source_primary_key | string | ※ | 統合元のお客様サービス側ユーザID |
dest_identifier | string | ※ | 統合先のソーシャルPLUS UID |
dest_primary_key | string | ※ | 統合先のお客様サービス側ユーザID |
nomerge | boolean | true の場合、統合後にユーザの個人情報を更新しません |
※ *_identifier
または *_primary_key
のいずれかを指定。詳しくは ユーザーの特定 を参照
リクエストサンプル
curl -X GET https://api.socialplus.jp/api/merge_user \
-d key={Web API キー} \
-d source_identifier={統合元のソーシャルPLUS UID} \
-d dest_primary_key={統合先のお客様サービス側ユーザID}
エラーレスポンス
関連: 共通エラー定義
エラーコード
HTTP ステータスコード | Code | Message | 説明 |
---|---|---|---|
401(Unauthorized) | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
500(Internal Server Error) | 3 | Operation failed. | ユーザ情報のマージに失敗しました |
400(Bad Request) | 5 | Required parameter not found. | 必須のパラメーターが指定されていません |
400(Bad Request) | 6 | Invalid parameter. | パラメーターに間違いがあります |
404(Not Found) | 7 | Entity not found. | 指定されたユーザが存在しません |
成功レスポンス
リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。
成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ok"
}
レスポンスパラメーター
パラメータ名 | 型 | 必須 | 最大長 | 説明 |
---|---|---|---|---|
status | string | ○ | 15 | リクエストが成功したかどうか(ok または failed ) |