ReDoc を使用して API を表示するには
エンドポイントのマニュアルの表示とテストを目的とした API へのアクセス |
BarTender には、API エンドポイントの完全なマニュアルに加えて、YAML、JSON、BTXML 形式での操作の例が付属しています。BarTenderインストール ファイルに付属するReDocを使用してBarTenderをインストールすると、このドキュメントを閲覧できます。
API で機能する独自のアプリケーションをデザインする前に、ツールを使用して API の使用方法をテストすることをお勧めします。Insomnia や Postman などの一般的なツールを使用して、API エンドポイントにアクセスできます。
Insomnia を使用して API エンドポイントにアクセスするには
リモート接続を使用するコンピュータで BarTender を実行する場合、API の実行と API マニュアルの取得の両方において、REST API にアクセスするときに以下のガイドラインを考慮してください。
Microsoft インターネットインフォメーションサービス (IIS) を設定し、BarTender REST API を実行するサーバーに Print Portal をインストールする必要があります。
API エンドポイントにアクセスするには、"http://<ホスト名または IP アドレス>/BarTender/api/actions" を使用します。
ReDoc マニュアルにアクセスするには、"http://<ホスト名または IP アドレス>/BarTender/api/actions/reference/index.html" を使用します。
認証の資格情報を求めるメッセージがブラウザに表示されることがあります。
ドメインユーザーとして実行するリモートコンピュータが同じ Windows ドメインにある場合、ドメインアカウントを使用してサインインできます。そうでない場合、そのリモートコンピュータのローカルアカウントが必要です。
REST API を実行するときに以下のエラーが発生することがあります。
401:URL で指定したコンピュータに HTTP クライアントがサインインできなかったことを示します。
403:統合の管理へのアクセス許可がないユーザーからサインイン要求が出されたことを示します。API を使用して操作または BTXML スクリプトを実行するには、Administration Console でユーザーの [統合の管理] に [許可] が指定されている必要があります。