BarTender Cloud ではどのような REST API が使用できますか
質問
どのような API が使用できますか。それぞれの API の機能はどのようなものですか。
対象
- BarTender Cloud REST API
- Automation サブスクリプション
Security API
Security API は、ユーザー、アクセス許可、グループ、および役割をすべて管理します。
セキュリティの基本
BarTender Cloud のセキュリティの仕組みはオンプレミスの BarTender と若干異なります。最大の違いは、アクセス許可を拒否する概念がないことです。
オンプレミスの BarTender には、(グループからの継承またはユーザーへの明示的な設定による) 拒否がある限り特定のユーザーの許可のアクセス許可を上書きする拒否の概念があります。そのため、ユーザーの有効なアクセス許可は、別の場所で許可されていても [常に拒否] になります。
Cloud にはそれほど明示的なものはなく、許可または不許可のアクセス許可システムで機能します。その結果、すべてのソース (役割、グループ、個々の設定) が統合され、ユーザーによる操作が許可されるかどうかが決定されます。ユーザーが 1 つのグループで特定の操作が許可されている場合、そのユーザーの別のグループに許可のアクセス許可設定がなくてもその操作が許可されます。 例えば、(ドキュメントを管理できる) ドキュメント管理グループに属しているユーザー A が (印刷のアクセス許可しかない) 印刷オペレータグループにも属している場合、一方のグループで許可されているため、ユーザー A にはドキュメントを管理するアクセス許可があります。
ユーザー管理
API では、以下の操作を行うことができます。
- ユーザーの作成
- ユーザーの削除
- ユーザー情報の更新
役割管理
役割は本質的にアクセス許可のコンテナです。これらのアクセス許可は、特定の役割内に含まれるすべてのユーザーに割り当てられます。
グループとユーザーに割り当てられた役割に基づいて、グループとユーザーのアクセス許可が設定されます。これらのアクセス許可を使用して、Web インターフェイスまたは API でファイルのアクセス許可を設定できます。 また、ユーザーやグループに特定の API へのアクセスを付与するかどうかを制御することもできます。
Printers API
Printers API (Print Management API とも呼ばれます) はプリンタに関するすべてのことを処理します。 これには、接続されたプリンタのクエリ、プリンタ情報の取得、ジョブ状態の印刷などが含まれます。現時点では、印刷履歴をクエリする API 呼び出しはありません。
多くの API 呼び出しは、クライアントコンピュータ上でローカルに実行する Print Gateway サービスと通信する Print Controller サービスによって処理されます。
プリンタ ID
プリンタ ID は、テナントスペース内のプリンタを一意に識別する手段です。各プリンタは、クライアント名とプリンタ名の組み合わせによって識別されます。
- printer:<clientname>/<printer_name>
例えば、ネットワークプリンタ Zebra が複数のクライアントに接続されている場合、この同一のプリンタの ID はクライアントごとに異なります。したがって、このプリンタをポイントするクライアントを一意に識別するために、プリンタは、printer:mariopc/Zebra_105、printer:luigipc/Zebra_105、printer:bowserpc/Zebra105 として表示されます。ライセンスはプリンタによって決定されるわけではないので、これはライセンスに影響せず、重複はありません。ID は単に Print Controller サービスにジョブの送信先を伝えるためのものです。
Librarian API
Librarian API は、Librarian スペース内に保存されたファイルとフォルダを操作する REST API です。これは、API 呼び出しを介したファイルおよびフォルダマネージャとして考えることができます。 両方の Librarian スペースへのアクセスがあり、両方のファイルとフォルダを操作できます。Librarian API はドキュメントの印刷を行いません。
Librarian URI
Librarian スペースには、ファイルやフォルダに加えて、ファイルやフォルダが保存されているスペースを識別し、Librarian スペース内から正しいバージョンを取得するために必要な追加情報を識別する独自の URL のセットがあります。URI は、Librarian API だけでなく、Librarian スペースに保存されているファイルを参照するために Action API でも使用されます。 ファイル URI は両方の API によって使用されますが、フォルダ URI は一般的に Librarian API によってのみ使用されます。
URI の一般的な構文を以下に示します。
- librarian://<space>/<path>[?parameter1=value1¶meter2=value2]
値とパラメータは & を使用して連結することができます。? はパラメータが存在する場合にのみ必要です。
2 つのスペースは、Main と $temp です。
URI の例
Main スペース
- librarian://Main/Shipping/Label.btw
- librarian://Main/MyLabel.btw?version=3
$temp スペース
- librarian://$temp/Work/File.txt
- librarian://$temp/label.btw
Actions API
Cloud Action API は、Cloud に印刷ジョブの自動化または更新を伝えます。これは BarTender REST API に似ていて同様の機能を持っていますが、Action API は YAML の呼び出しだけを取ることができ、その操作は Cloud 環境内で実行することが安全と見なされたものに制限されます。API には、データベース操作や [SQLを実行] などの操作は含まれません。完全なリストについては、API のマニュアルを参照してください。
ラベルの印刷に加えて、Action API は実行中の現在の操作に関する情報の取得とフォルダとファイルへの操作の実行を行うことができます。 ほとんどのフォルダタスクは Librarian API によって処理されます。
その他の API との連携
リソースの正確な場所や適切なアドレスがわからない場合、その他の API を使用して情報を見つけることができます。
- Librarian API: ファイルの場所を見つけます。
- Print API: プリンタ名と情報を取得します。
これらは個別の API なので、必要な情報を取得するには複数の呼び出しを行う必要があります。既に情報がわかっている場合、追加の呼び出しをスキップして操作呼び出しを行うことができます。