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

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

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

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

GET /api/create_user
注記

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

リクエスト​

Path パラメーター​

パラメータ名型必須説明
keystring○Web API キー
primary_keystring作成と同時に紐付けるお客様サービス側ユーザID
provider_user_idsobject作成と同時に紐付ける、既存のログインプロバイダ側ユーザー識別子。Provider User ID オブジェクト 参照

Provider User ID オブジェクト​

キー型必須最大長説明
{ログインプロバイダ}string255キーはログインプロバイダになります。ログインプロバイダ側で発行されたユーザー識別子
provider_user_ids を指定したい場合

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

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

リクエストサンプル​

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

エラーレスポンス​

関連: 共通エラー定義

エラーコード​

HTTP ステータスコードCodeMessage説明
401（Unauthorized）1Invalid API key or key not found.Web API キーが指定されていないか、存在しない Web API キーです
400（Bad Request）6Invalid parameter.パラメーターに間違いがあります
400（Bad Request）16Duplicated primary key.指定された primary_key は、すでに別のユーザーに関連付けられています

成功レスポンス​

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

成功時のレスポンス例（お客様サービス側ユーザID を紐付けた場合）
HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok",
  "user": {
    "identifier": "75b94dad58a031d4366dfe51fb5806afc9b41c5e",
    "primary_key": "user_123"
  }
}
成功時のレスポンス例（ログインプロバイダ側のユーザー識別子を紐付けた場合）
HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok",
  "user": {
    "identifier": "75b94dad58a031d4366dfe51fb5806afc9b41c5e",
    "primary_key": "user_123",
    "provider_user_ids": {
      "line": "U9810e27f7b07a65c69be1219f3400000"
    }
  }
}

レスポンスパラメーター​

パラメータ名型必須最大長説明
statusstring○15リクエストが成功したかどうか（ok または failed）
userobject○-User オブジェクト 参照

User オブジェクト​

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