質問

認証はどのように機能しますか。トークンとは何ですか。

対象 

BarTender Cloud REST API

回答

Cloud REST API では認証が必要です。認証されない呼び出しは API ゲートウェイに到達できません。 基本認証を使用するオプションや認証なしでコマンドを送信するオプションはありません。認証されていない呼び出しは認証ゲートで止められ、処理を続行することはできません。

認証の基本的な仕組みを以下に示します。

トークンとは

ユーザー名とパスワードを使用する代わりに、API はアクセストークンを利用します。トークンは英数字と記号の意味のない長い文字列のように見えますが、誰が API 呼び出しを行っているのか、そして API 呼び出しがどこに向かっているのかに関する重要な情報が含まれています。一般的に、トークンは次のように見えます。

このトークンには、2 つの主要な情報が含まれています。

• テナント ID - この呼び出しの送信先のテナントスペースを API に伝えます。
• ユーザー ID - 呼び出しを行っているユーザーの ID を識別します。

この情報がない場合、トークンは拒否され、API 呼び出しは戻されます。

この情報は ID プロバイダ (OAuth) によって生成されます。 これは、Web インターフェイスで Cloud へのログインを許可するのと同じプロバイダです。

トークンの取得場所

トークンは、Cloud インターフェイスからのユーザーのプロファイル設定または [クラウドアカウントを管理] セクションの下にあります。テナントスペースに Automation サブスクリプションがある場合、API オプションは左側のメニューの下部に表示されます。

トークンを使用するアプリケーション

API 呼び出しを行うすべてのアプリケーションは最終的にトークンを使用しますが、トークンを明示的に定義するのは Insomnia や Postman のようなプライベートアプリケーションだけです。

Web アプリケーションは (呼び出しを行って API と対話するために構築されたカスタムインターフェイス)、OAuth 呼び出しを使用してログインダイアログを作成します。OAuth がユーザーの ID を検証した後にアクセストークンが生成され、API へのその他の呼び出しと同様の処理が行われます。

さまざまな種類のアプリケーションでの認証の使用方法とその違いの詳細については、「Cloud REST API アプリケーションの種類」を参照してください。

ローカルプリンタとトークンに関する重要なメモ

特定のクライアントシステム上のプリンタを使用するには、クライアントが少なくとも一度は Cloud にログインして接続を確立する必要があります。Cloud 自身の印刷ダイアログから Print Gateway をインストールする場合、この接続設定は自動的に行われます。

Cloud の印刷ダイアログからではなく、インストーラから Print Gateway をインストールし、Print Gateway を設定するために Cloud にログインしない場合、Print Gateway と Cloud の通信を許可する特殊なトークンが必要です。

この特殊なトークンは、Print Gateway 設定の上部にあります。

このトークンは、クライアントシステムが Cloud にログインして Print Gateway を設定しない場合にのみ必要です。クライアントがログインしている場合、または Print Gateway が印刷ダイアログから直接インストールされている場合、Web インターフェイスの Cloud 設定で提供されたアクセストークンが引き続き使用されます。