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

ソーシャルPLUS ユーザの作成

ソーシャルPLUS ユーザを作成し、新しいソーシャルPLUS ID を発行します。

パラメータを指定することにより、ユーザの作成と同時にお客様サービス側ユーザID と紐付けることができます。

GET /api/create_user
注記

この API で作成したユーザにはどのログインプロバイダも紐付いておらず、個人情報も登録されていません。

リクエストパラメータ

パラメータ名必須説明
keystringAPI キー
primary_keystring作成と同時に紐付けるお客様サービス側ユーザID

エラーコード

HTTP StatusCodeMessage説明
4011Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
4006Invalid parameter.パラメーターに間違いがあります
40016Duplicated primary key.指定された primary_key は、すでに別のユーザに関連付けられています

レスポンス

キー最大長説明
statusstring15リクエストが成功したかどうか(ok または failed
userobject-User オブジェクト 参照

User オブジェクト

キー最大長説明
identifierstring40作成したユーザのソーシャルPLUS ID
primary_keystring255作成したユーザに紐付けたお客様サービス側ユーザID
provider_user_idsobject-Provider User ID オブジェクト 参照。任意のパラメータ。ユーザ作成時に、既存のログインプロバイダ側ユーザ識別子を紐付けたい場合に指定
provider_user_ids を指定したい場合

先に対象のログインプロバイダの設定を行う必要があります。

ソーシャルPLUS のプロバイダ設定が済んでいないログインプロバイダのユーザ識別子を指定した場合、API はエラーにならず、値が紐づきません

Provider User ID オブジェクト

キー最大長説明
{ログインプロバイダ}string255キーはログインプロバイダになります。ログインプロバイダ側で発行されたユーザ識別子

レスポンス例

お客様サービス側ユーザID を紐付けた場合
{
"status": "ok",
"user": {
"identifier": "75b94dad58a031d4366dfe51fb5806afc9b41c5e",
"primary_key": "user_123"
}
}
ログインプロバイダ側のユーザ識別子を紐付けた場合
{
"status": "ok",
"user": {
"identifier": "75b94dad58a031d4366dfe51fb5806afc9b41c5e",
"primary_key": "user_123",
"provider_user_ids": {
"line": "U9810e27f7b07a65c69be1219f3400000"
}
}
}

実行サンプル

お客様サービス側ユーザID を紐付ける場合
curl -X GET https://api.socialplus.jp/api/create_user -G \
-d key={API Key} \
-d primary_key=user_123
ログインプロバイダ側のユーザ識別子を紐付ける場合
curl -X GET https://api.socialplus.jp/api/create_user -G \
-d key={API Key} \
-d primary_key=user_123 \
-d provider_user_ids[line]=U9810e27f7b07a65c69be1219f3400000