Print Portal ユーザーインターフェイスおよびマニュアルでは、Print Portal で使用可能なフォルダとしてルートフォルダを参照します。REST API は、これらのフォルダを「ライブラリ」として参照します。ルートフォルダのリストを要求 (列挙) する際の出力例は実際の出力と異なります。ルートフォルダ (ライブラリ) の内容を列挙する際、サブフォルダおよびその項目 (サブフォルダまたはドキュメント) が一覧表示されます。
REST API は、Web リソースの内容のテキスト表現を取得および操作するためのソフトウェアアーキテクチャスタイルです。Print Portal REST API はデータを JSON 形式で表すので、送受信データは JSON 形式です。
このチュートリアルで使用する例では、ブラウザを使用して URL 要求を送信し、応答を取得します。要求をプログラミングで構築する JavaScript の例もあります。
このチュートリアルのステップでは、Print Portal がインストールされているクライアントのブラウザを使用するので、URI 文字列で "localhost" を使用します。
Print Portal には、Swagger と呼ばれる REST API 規格体系が含まれます。Swagger は、各関数の説明および要求のテストの実行環境を提供する REST API のヘルプシステムと考えることができます。
|
|
To view the Swagger user interface, add "swagger" after "BarTender" in the BarTender URI, as follows: http://localhost/BarTender/swagger/ |
Swagger の画面は 2 つの部分で構成されます。上部には、API 関数の説明および API 要求をテストする機能が含まれます。[モデル] というタイトルが付いた下部には、各関数の説明と要件が表示されます。たとえば、printRequestID の詳細を確認する場合、[モデル] セクションに移動し、[PrintRequest] をクリックすると、引数とその定義のリストが表示されます (そのうちの 1 つが printRequestID です)。