基本的なシングルサインオン

Uberall 独自のトークンを使用した Uberall シングルサインオン API 機能の紹介

+ More

フロントエンドユーザーポータルは、シングルサインオンソリューションを統合することで利用できます。これにより、エンドユーザーは1つのプラットフォームにのみサインインし、その後はユーザーポータルにサインインする必要がなくなります。シングルサインオンは、APIを使用してaccess_tokenを生成し、そのトークンを使用してユーザーをプラットフォームにログインさせることで実現されます。

要件

シングルサインオン機能を使用する前に、次の 2 つの要件があります。

1- API キーにアクセスできる。

2- 既存のユーザーセットがあること。

APIキー

APIキーは、管理者レベルのユーザーであれば、フロントエンドユーザープラットフォームから取得できます。画面右上のドロップダウンリストで現在のユーザーのメールアドレスを入力し、「APIキー」をクリックすることで取得できます。秘密鍵と公開鍵の両方が表示されます。

*これらのキーは機密情報であるため、電子メールで伝達しないでください。

ユーザー作成

SSOでユーザーを認証する前に、ユーザーが既に作成されている必要があります。手動でのユーザー作成については、こちらで説明されています。この呼び出しでAPI経由でも作成できます。

***これ は のみ 一つの 例 そして は ない その のみ 方法 に 策定する その 体 の これ 電話。

役職 https://uberall.com/api/users

ヘッダー ＝ {
「秘密鍵」: $API_KEY、 
「コンテンツタイプ」: 「アプリケーション/json」
}

体 ＝ {
        "役割"： $USER_ROLE、
        「挨拶」: $USER_SALUTATION、
        "ファーストネーム"： $USER_FIRSTNAME、
        "苗字"： $USER_LASTNAME、
        「メール」: $USER_EMAIL、
        "特徴"： [$USER_FEATURE_1, $USER_FEATURE_2]、
        「ホワイトラベル情報識別子」: $USER_WHITELABEL_IDENTIFIER、
        "状態"： $USER_STATUS、
        "識別子"： $ユーザーID、
        「メール設定」: [
              {
                「メールタイプ」: 「ダイジェスト」、
                "頻度"： $ユーザーダイジェスト頻度
              },
              {
                「メールタイプ」: 「未読レビュー通知」、
                "頻度"： $ユーザーレビュー通知頻度
              }
            ],
        「管理対象ビジネス」: [$USER_MANAGED_BUSINESS_1, $USER_MANAGED_BUSINESS_2]、
        「優先言語」: $ユーザー推奨言語
      }

利用可能なすべてのフィールド値は、完全な API ドキュメントで確認できます。

APIでサインイン

ユーザーを認証し、アクセストークンを取得する方法は複数あります。これらの方法はすべて同じAPIエンドポイントを使用します。ユーザー認証API呼び出しに関する完全なドキュメントは、こちらでご覧いただけます。

access_token には有効期限があり、期限切れになることに注意してください。そのため、ユーザープロビジョニングフローではこの点を必ず考慮してください。

メールアドレスとパスワードの組み合わせ

ユーザーに既知のパスワードが割り当てられている必要があります。
次のAPI呼び出しを使用して、電子メールとパスワードの組み合わせでユーザーを認証します。

役職 https://uberall.com/api/users/login

ヘッダー ＝ {
        「コンテンツタイプ」: 「アプリケーション/json」
      }
体 ={
  「メール」: $USER_EMAIL、
      "パスワード"： $ユーザーパスワード
}

応答：
{
  "状態"： "成功"、
  "応答"： {
    「アクセストークン」: 「ユーザー アクセス トークン ここ"
  }
}

メールアドレスと秘密鍵の組み合わせ

ユーザーのメールアドレスが必要です。ユーザーのメールアドレスは、ユーザーの作成時またはこのAPI呼び出しで取得できます。
次のAPI呼び出しを使用して、電子メールと秘密キーの組み合わせでユーザーを認証します。

役職 https://uberall.com/api/users/login

ヘッダー ＝ {
「秘密鍵」: $API_KEY、
        「コンテンツタイプ」: 「アプリケーション/json」
      }
体 ={
  「メール」: $USER_EMAIL
}

応答：
{
  "状態"： "成功"、
  "応答"： {
    「アクセストークン」: 「ユーザー アクセス トークン ここ"
  }
}

ユーザーIDと秘密鍵の組み合わせ

ユーザーIDが必要です。ユーザーIDは、ユーザー作成時またはこのAPI呼び出しで取得できます。
ユーザー ID と秘密キーの組み合わせでユーザーを認証するには、次の API 呼び出しを使用します。

役職 https://uberall.com/api/users/login

ヘッダー ＝ {
「秘密鍵」: $API_KEY、
        「コンテンツタイプ」: 「アプリケーション/json」
      }
体 ={
  "ユーザーID"： $ユーザーID
}

応答：
{
  "状態"： "成功"、
  "応答"： {
    「アクセストークン」: 「ユーザー アクセス トークン ここ"
  }
}

access_token を取得したら、それをユーザーポータルのベース URL に追加してユーザーを認証できます。

https://uberall.com/en/app/uberall?access_token=ACCESS_TOKEN_HERE

シングルサインオン基本