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

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

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

• 認証対象のソーシャルPLUS ID の取得（authenticated_user）API の応答にお客様サービス側のユーザID が含まれるようになります
• ユーザを指定して実行する API について、ソーシャルPLUS ID ではなくお客様サービス側のユーザID による指定が可能になります

GET /api/map

注記

すでにお客様サービス側のユーザID が紐付くソーシャルPLUS ユーザに対してこの API を実行すると "Field existed and overwrite disabled." エラーになります。

エラーにさせず強制的に紐付ける（上書きする）場合は overwrite パラメータに true を指定してください。

リクエストパラメータ

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

注記

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

エラーコード

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.	指定されたユーザが存在しません
403	8	Field existed and overwrite disabled.	すでに紐付けされているため上書きできません
400	16	Duplicated primary key.	指定された primary_key は、すでに別のユーザに関連付けられています

レスポンス

キー	型	最大長	説明
status	string	15	リクエストが成功したかどうか（ok または failed）

レスポンス例

{
  "status": "ok"
}

実行サンプル

curl -X GET https://api.socialplus.jp/api/map -G \
  -d key={API Key} \
  -d identifier={SocialPLUS ID} \
  -d primary_key={Primary Key}