ログインプロバイダの連携追加用トークンの発行
既存のソーシャルPLUS ユーザに対して別のログインプロバイダを紐付ける際に必要なトークンを発行します。
GET /api/association_token
注記
トークンの発行が正常に行われた場合、レスポンスには次の手順となるソーシャルログイン用の URL が組み立てられた状態で返されます。
これに 「コールバック URL」をパラメータ callback として追加して ご利用ください。
注記
トークンは、１ユーザに対し１つのみ発行可能です。続けてトークンを発行しますと、以前に発行したトークンは無効化されます。
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| key | string | ○ | API キー |
| identifier | string | △ | 対象のソーシャルPLUS ID |
| primary_key | string | △ | 対象のお客様サービス側ユーザID |
| target_provider | string | ○ | 追加で紐付けるログインプロバイダ |
エラーコード
| 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. | 指定されたユーザが存在しません |
| 400 | 11 | Specified provider settings incomplete. | 指定されたログインプロバイダの設定が完了していません |
| 409 | 15 | Specified provider already associated with this user. | 指定されたログインプロバイダは、すでにこのユーザと紐付いています |
レスポンス
| キー | 型 | 最大長 | 説明 |
|---|---|---|---|
| status | string | 15 | リクエストが成功したかどうか（ok または failed） |
| token | object | - | Token オブジェクト |
| authenticate_uri | string | 2083 | ログインプロバイダの連携追加のためのソーシャルログイン URL |
Token オブジェクト
| キー | 型 | 最大長 | 説明 |
|---|---|---|---|
| token | string | 40 | ログインプロバイダの連携追加用トークン |
| expired_at | timestamp | - | ログインプロバイダの連携追加用トークンの有効期限 |
レスポンス例
{
"status": "ok",
"token": {
"token": "4037d6fb129f8d731434ccc2b36f7b64cea327a4",
"expired_at": "2021-06-24T06:10:28Z"
},
"authenticate_uri": "https://123456789.auth.socialplus.jp/account/site/yahoo/authenticate/associate?token=4037d6fb129f8d731434ccc2b36f7b64cea327a4"
}
実行サンプル
curl -X GET https://api.socialplus.jp/api/association_token -G \
-d key={API Key} \
-d primary_key={Primary Key} \
-d target_provider=yahoo