メインコンテンツへスキップ
Deutsch English (United States) Español Français 简体中文 繁體中文

検索

このセクションの記事

BarTender Cloud REST API レガシー認証

Shamanth Vohra

BarTender Content Team

  • 更新

概要

以前のバージョンのBarTender Cloudでは、WebアプリケーションがBarTender Cloud REST APIへアクセスするためにOAuth 2.0とOpen ID Connect（OIDC）を使用していました。OAuthは、サービスがサードパーティのWebアプリとデータを共有するための認証メカニズムです。ログイン認証情報を共有する代わりとなり、それに伴うセキュリティリスクを回避できます。OIDCはOAuth 2.0フレームワーク上で動作するオープンな認証プロトコルです。

BarTender Cloudの強化されたIDプロバイダーは社内認証もサポートしていますが、この記事では従来のOAuth認証の仕組みについて詳しく解説します。この内容は上級者向けのため、技術的な知識をお持ちの方を対象としています。

対象

BarTender Cloud REST API

情報

Webアプリケーション登録手順

BarTender CloudでWebアプリケーションを登録するには、管理 > APIキー > OAuthアクセス用アプリケーション登録に進みます。

「名前」と「説明」をそれぞれの欄に入力してください。その他の項目については、以下の要件をご確認ください：

  1. ログインURI：ユーザーがリダイレクトされるWebアプリケーション内の認可エンドポイントです。リダイレクトについて詳しくはこちらをご覧ください。
  2. コールバックリスト：BarTender Cloudが認証後にレスポンスを送信するWebアプリケーション内のURLリストです。
  3. ログアウトURL：ユーザーがログアウトした際にリダイレクトされるWebアプリケーション内のエンドポイントです。
  4. 許可されたオリジン（CORS）：推奨はされませんが、クロスオリジン認証を利用すると、認証フォームをアプリケーション内に直接埋め込むことができます。埋め込みログインが必要な場合は、アプリケーションでクロスオリジンリソース共有（CORS）の設定が必要です。 CORSについて詳しくはこちらをご覧ください。
  5. 許可されたWebオリジン：クロスオリジン認証を実行できるURLです。 クロスオリジン認証について詳しくはこちらをご覧ください。

登録パラメータの詳細については、ヘルプドキュメントのWebアプリケーション > BarTender CloudへのWebアプリケーション登録方法をご参照ください。

OAuth認証プロセス

簡単に言うと、OAuthは第三者サービスがあなたのパスワードを明かすことなく、あなたの名前でBarTender Cloudのコンテンツへアクセスできるようにする仕組みです。これはWebアプリケーションがBarTender Cloud REST APIへアクセスする際の認証プロセスです。 

OAuth技術詳細

BarTender Cloudは、認証プロセスを管理するためにOAuthプロバイダーであるAuth0を利用しており、サードパーティのWebアプリケーションはAuth0のAPIを使ってBarTender Cloudに認証する必要があります。

BarTender CloudはWebアプリケーションの認可にAuth0の認可コードフローを使用し、信頼されたアプリケーション向けにはリソースオーナーパスワードフローも提供しています。

OAuth認可コードフロー

以下は、サードパーティWebアプリケーション（クライアント）を通じてBarTender Cloudに認証し、テナントスペースへアクセスする際のアプリケーションフローをステップごとに説明したものです：

  1. アプリケーション内で ログイン を選択します。

  2. Auth0のSDKが認可サーバーへリダイレクトします。該当するURLは以下の通りです：

  3. 認可サーバーがログインおよび認可プロンプトへリダイレクトします。

  4. 設定されたログインオプションのいずれかで認証します。アプリケーションに付与される権限が表示される同意画面が表示される場合があります。

  5. 認可サーバーがアプリケーションへワンタイムの認可コードを返します。

  6. 認可サーバーが認可コード、アプリケーション/クライアントID、およびアプリケーション/クライアントシークレットを検証します。

  7. 認可サーバーがIDトークンとアクセストークン（必要に応じてリフレッシュトークンも）を返します。

  8. アプリケーションはアクセストークンを使って、Audienceパラメータで指定したAPIを呼び出し、BarTender Cloudのデータや機能へアクセスできます。

    • Audienceはアクセスしたい特定のAPIエンドポイントを示します。

  9. APIがリクエストされたデータを返します。

Auth0 API

Auth0 APIをアプリケーションに統合する方法については、Webアプリクイックスタートガイドもご参照ください。

追加リソース

ヘルプドキュメント：

サポート記事：

その他の外部リソース （著作権は各権利者に帰属します）：

関連記事