お客様サービス側ユーザID の紐付け

ソーシャルPLUS UID に対して、お客様サービス側のユーザID を紐付けます。

GET /api/map

これを行うことで以下が可能になります。

• ID Token のペイロード や Userinfo エンドポイントのレスポンス にお客様サービス側のユーザID が含まれるようになります
• ユーザを指定して実行する API について、ソーシャルPLUS UID ではなくお客様サービス側のユーザID による指定が可能になります

リクエスト

Path パラメーター

パラメータ名	型	必須	説明
key	string	○	Web API キー
identifier	string	○	対象のソーシャルPLUS UID
primary_key	string	○	紐付けるお客様サービス側ユーザID
overwrite	boolean		true の場合、すでに紐付けられたお客様サービス側ユーザID があっても上書きします

注記

この API では identifier と primary_key の両方の指定が必要です。

リクエストサンプル

curl -X GET https://api.socialplus.jp/api/map \
  -d key={Web API キー} \
  -d identifier={ソーシャルPLUS UID} \
  -d primary_key={お客様サービス側のユーザID}

エラーレスポンス

関連: 共通エラー定義

エラーコード

HTTP ステータスコード	Code	Message	説明
401（Unauthorized）	1	Invalid API key or key not found.	Web API キーが指定されていないか、存在しない Web API キーです
400（Bad Request）	5	Required parameter not found.	必須のパラメーターが指定されていません
400（Bad Request）	6	Invalid parameter.	パラメーターに間違いがあります
404（Not Found）	7	Entity not found.	指定されたユーザが存在しません
403（Forbidden）	8	Field existed and overwrite disabled.	すでに紐付けされているため上書きできません
400（Bad Request）	16	Duplicated primary key.	指定された primary_key は、すでに別のユーザに関連付けられています

成功レスポンス

リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。

成功時のレスポンス例

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok"
}

レスポンスパラメーター

パラメータ名	型	必須	最大長	説明
status	string	○	15	リクエストが成功したかどうか（ok または failed）