BarTender Cloud REST API アプリケーションの種類.
質問
REST API に対して RESTful 呼び出しを行うことができるのはどの種類のアプリケーションですか。どのような違いがありますか。
対象
BarTender Cloud REST API
Automation サブスクリプション
回答
REST API 呼び出しを行うとき、API ゲートウェイが呼び出しを処理する前にアプリケーションはトークンを送信し、認証を受ける必要があります。2 種類のアプリケーションの両方ともにセキュリティゲートを介してトークンを渡す必要がありますが、トークンを取得する方法は異なります。
2 種類のアプリケーションを以下に示します。
- プライベート/ダイレクトアプリケーション - Insomnia、Postman など
- Web アプリケーション - カスタムアプリケーション
プライベートアプリケーション
プライベートアプリケーション (ダイレクトアプリケーション) は API 呼び出しを REST API に直接送信します。これらの API 呼び出し外で追加の呼び出しが行われることはありません。Insomnia や Postman などのアプリケーションは、このカテゴリに分類されます。
ダイレクトアプリケーションはトークンを使用してセキュリティゲートを介して API 呼び出しを行います。
トークンは、Cloud の Web インターフェイスから手動で取得する必要があります。通常は、ユーザーのプロファイル設定または [クラウドアカウントを管理] の Cloud API セクションの下にあります。
ダイレクトアプリケーションの場合、すべての API 呼び出しと共にセキュリティトークンを送信する必要があります。 例えば、Insomnia の場合、[認証] タブでトークンを運ぶことができます。トークンはベアラートークン (Insomnia からのメッセージベアラーによって提供される認証トークン) としてリストされます。トークンオプションを選択した後、トークンを貼り付けると API メッセージと共に運ばれます。
Web アプリケーション
Web アプリケーションは C# などの言語に組み込まれ、完全に機能するインターフェイスとして動作します。ログインして Cloud で認証を受けるなどのユーザー操作を行うことができます。これらの種類のアプリケーションには、トークンを取得するための追加のステップがあり、最終的にセキュリティゲートを介して API 呼び出しが行われます。認証プロセスのフローチャートを以下に示します。
多くの追加ステップがありますが、ダイレクトアプリケーションではなく、このアプリケーションを選択する理由は何でしょうか。 OAuth ID プロバイダでの認証プロセスでは、ログインごとにセキュリティトークンが更新されるので、ユーザーはトークンを直接取り扱う必要はありません。すべての処理は OAuth とアプリケーション自身によって行われます。アプリケーションが有効なトークンを取得すると、API 呼び出しの送信を開始し、セキュリティゲートを介して渡すことができます。
Web アプリケーションは Cloud 上に登録する必要があります。これで認証されたアプリケーションだけが Cloud で作業できることが保証されます。認証されていない場合、アクセスが拒否されます。登録は、Cloud Web インターフェイスからのユーザープロファイル設定または [クラウドアカウントを管理] の Cloud API セクションの下にあります。
Web アプリケーションを登録する際、アプリケーション自身に関するいくつかの質問が尋ねられます。各フィールドには、正しい情報を正しい場所に配置し、アプリケーションを適切に登録するための短い説明があります (保存名や説明など)。
すべてのアプリケーションは、[Web アプリケーション登録] セクションのリストに表示されます。
カスタム Web アプリを記述する方法と認証ダイアログを生成する方法については、起動の際に表示されるいくつかの例を参照してください。例と詳細については、BarTender Cloud ヘルプを参照してください。