はじめに

BarTender 2021 以降では、プログラマーが REST API の包括的なセットを通じて Print Portal と連携できるようになりました。REST API を利用して、ユーザー認証、既存のフォルダー、ラベル、プリンターの一覧表示、ラベルの印刷など、ほとんどの操作をクエリの発行と JSON 形式での結果取得によって実行できます。

この記事では、Print Portal REST API の概要を簡単にご紹介します。REST API の認証方法や、API テスト用の swagger ツールの使い方についても説明します。

エンドポイントとメソッド

Print Portal REST API は RESTful の原則に基づいて設計されており、最も一般的な 2 つの HTTP メソッド、GET と POST をサポートしています。 

Print Portal REST API では、エンドポイント URI を通じてリソースにアクセスします。すべての Print Portal API エンドポイントは、以下の ベース URL を持っています。

{Print Portal Base URL}/BarTender 

REST API リクエストを送信する際は、特定のエンドポイントを使用する必要があります。Print Portal API V1 には、以下のように分類された 4 つのエンドポイント があります。

表 1-1 Print Portal REST API エンドポイントとメソッド

/api/v1/Authenticate

/api/v1/print

/api/v1/libraries/{id}

/api/v1/printers/{printerName}

認証について

認証が有効な場合、Print Portal のリソースにアクセスするには、認証済みユーザーからのリクエストである必要があります。認証に成功すると、トークンが返されます。

認証トークンを生成するには、POST リクエストを以下に送信します。

{Print Portal Base URL}/BarTender/api/v1/Authenticate

リクエストボディは以下の形式です。

{
 "userName": "UserName@Domain",
 "password": "Password"
}

これにより、token プロパティを含む JSON 形式のユーザーストラクチャが返されます。

{
 "success": true,
 "token": "string",
 "expires_in": 0
}

REST API エンドポイントを呼び出す際は、すべてのリクエストに以下の形式で Authorization ヘッダーを付与してください。

Authorization: Bearer <TokenString>

Swagger UI の使い方

Print Portal には swagger という REST API 仕様システムも含まれています。Swagger UI を使うと、API のリソースを実際の実装ロジックなしで可視化・操作できます。swagger は REST API のヘルプシステムのようなもので、各機能の説明や、リクエストのテスト実行環境、機能ごとの解説を提供します。

swagger には、Print Portal のベース URL の BarTender の後ろに swagger を付けてアクセスできます。例：

{Print Portal Base URL}/BarTender/swagger/

swagger の画面は上下 2 つのセクションに分かれており、必要な情報を探す際に知っておくと便利です。上部にはAPI 機能の説明と API リクエストのテスト実行があり、下部の「Models」セクションには各機能とその要件の説明があります。

前述の通り、Swagger UI には API のテストを簡単に行える便利な機能が備わっています。例えば認証のテストを行う場合は、該当する項目を展開して認証要件を確認できます。

「Try it out」ボタンを選択し、以下の形式でユーザー名とパスワードを入力します。

その後、大きな青い Execute ボタンをクリックします。

これにより（PrintPortal の認証が有効で、正しいユーザー名とパスワードが入力されていれば）、今後の REST API 呼び出しで使用するための 認証トークン が返されます。

さらに詳しい情報

Print Portal の自動化を始める際に役立つ追加情報については、Print
Portal のヘルプシステムをご参照ください。