Open topic with navigation

BarTender REST API は、YAML や JSON ファイル形式、または既存のレガシー BTXML スクリプトを使用することによって Windows 以外のプラットフォーム上のシステム、またはネットワーク全体にわたるシステムを自動化するために使用できる REST エンドポイントを提供します。BarTender REST API を使用することによって、C#、Java、Perl、Python などを始めとするほとんどの種類のプログラミング言語、およびほとんどの統合開発環境 (IDE) を使用して自動化スクリプトを作成できます。

サポートされている技術

BarTender REST APIは、Integration BuilderとProcess Builderで使用されているPrint Schedulerサービスを使用します。サーバーとの通信はポート 5159 を介して行われます。

スクリプトの送信と応答の受信では、API は JSON、YAML、および BTXML 形式のデータペイロードをサポートします。YAML の参照ドキュメントは BarTender と共にインストールされます。詳細については、「Available Actions in the Actions API」を参照してください。BTXML の詳細については、「BTXML スクリプトの使用」を参照してください。

API は以下の技術をサポートします。

• クロスオリジンリソース共有 (CORS): 任意の Web サイトから REST エンドポイントにアクセスすることを可能にします。

• 複数の認証スキーム: 基本認証、統合認証 (Microsoft ネゴシエート)、Windows チャレンジ/レスポンス (NTLM) など。

  セキュリティの理由から、基本認証は既定で無効化されています。基本認証を有効にするには、appsettings.json 構成ファイルで基本認証の設定を "true" に変更します。このファイルは以下のディレクトリにインストールされています。 C:\Program Files\Seagull\BarTender 2022\net6.0

• セキュアな HTTPS

要件

BarTender REST API を使用するには、以下の条件を満たす必要があります。

• Automation または Enterprise エディションの BarTender 2022 を実行していること。

• ポート 5159 が開いていて、API が REST コマンドを受信できること。

• サーバーにサインインするアクセス許可、および Administration Console で設定されているように統合を管理するアクセス許可があること。

このセクションの内容

• エンドポイントのマニュアルの表示とテストを目的とした API へのアクセス

  BarTender REST API へのアクセス、および自動化スクリプトのテストに使用できるアプリケーションについて説明します。

• Actions API

  スクリプトの作成に使用できる BarTender REST API コマンドについて説明し、サンプルコードを提供します。