BarTender Cloud REST API のアプリケーション種類
質問
どのような種類のアプリケーションがREST APIに対してRESTfulコールを行うことができますか?また、それぞれの違いは何ですか?
対象
BarTender Cloud REST API
Automationサブスクリプション
回答
REST APIコールを行うことができるアプリケーションは2種類あります:
- コンソールアプリケーションおよびサービス - Insomnia、Postman、GUIを持たないカスタムアプリケーションなど
- Webアプリケーション - カスタムまたはサードパーティ製アプリケーション
REST APIコールを行う際は、アプリケーションがトークンを送信し、認証される必要があります。その後、APIゲートウェイがコールを処理します。
どちらのタイプもセキュリティゲートを通過するためにトークンが必要ですが、トークンの取得方法が異なります。
テスト用認証情報アクセストークン
BarTender Cloudでは、REST APIのテストをすぐに始められるよう、一時的なアクセストークンを生成する簡単な方法を提供しています。以下の手順で取得できます:
- ホームページから、左側のサイドバーで管理をクリックし、APIキーを選択します。
- 下部にあるアクセストークンを表示をクリックします。
3. ポップアップダイアログでアクセストークンをコピーボタンをクリックし、アプリケーションに貼り付けます。
Webアプリケーション(認可コードフロー)
WebアプリケーションはC#などの言語で構築され、フル機能のインターフェースとして動作します。これらは多くの場合サードパーティ製アプリケーションであり、ユーザーが直接認証情報を共有したくない場合もあるため、BarTender Cloudではアプリケーションが認証情報にアクセスせずに認証できる方法を提供しています。このタイプのアプリケーションは、トークンを取得してセキュリティゲートを通過し、APIコールを行うまでに追加の手順が必要です。
カスタムWebアプリの作成方法や認証ダイアログの表示方法についての例がいくつかあります。詳しくはBarTender Cloudヘルプのこちらをご覧ください。
コンソールアプリケーションおよびサービス(パスワード認証)
BarTender Cloudのログインダイアログを表示できないコンソールアプリケーションやサービスは、パスワード認証を使用する必要があります。GUIを表示できないアプリケーションはこのカテゴリに該当します。また、この方法はInsomniaやPostmanなどのアプリケーションでのテストにも利用でき、実装も簡単です。
この仕組みの詳細については、以下の記事をご覧ください:BarTender Cloud REST API パスワード認証。