Domino Administrators - What You Need to Know About the Domino REST API の翻訳版です。
Domino 管理者が Domino REST API について知っておくべきこと
2023年10月27日
著者: Heather J Hottenstein / Technical Advisor
HCL Domino REST API は、外部システムが Domino アプリケーションデータに安全にアクセスする機能を提供します。また、開発者が好みのプログラミング言語を使用できるため、Domino との対話に必要なスキルセットが広がります。最終的に、Domino REST API は Domino アプリケーションの拡張、モダナイズ、変換を可能にします。
Domino REST API によって提供される機能は、アプリケーション開発に重点を置く人向けであることは事実ですが、Domino 管理者もこの新しい追加機能を理解する必要があります。管理者はサービスを保護するのが仕事です。Domino REST API は Domino サーバー上で実行されるため、それが適切にインストールされ、 設定され、監視されていることを確認するのは管理者の責任となります。
Domino REST APIは、Windows、Linux、またはDocker/Kubernetesコンテナ上で動作するDomino 12.0.2+サーバー上で実行されます。他のHCLSoftwareと同様に、HCL License and Download Portal にアクセスして、それぞれのプラットフォーム用のHCL Domino REST APIをダウンロードしてください。
ダウンロード・パッケージは tar.gz 形式で、圧縮ファイル形式です。ファイルを解凍する必要があります。例えば、7-Zip を使用する Windows OS では、次のようにします。
restapiInstall-r12.jar ファイルはインストーラーファイルです。このファイルを Domino サーバーのプログラムフォルダー、つまり nserver.exe があるフォルダーにコピーします。
Windows サーバーに Domino REST API をインストールするには、管理者として Windows CMD プロンプトを実行し、ディレクトリを Domino プログラムフォルダーに変更して次のコマンドを実行します。
java -jar c:\domino\restapiinstall-r12.jar -d="C:\Domino\Data" -i="C:\Domino\notes.ini" -r= C:\Domino\restapi" -p="C:\Domino\restapi" -a
注:上記のパスを Domino サーバー上のパスに変更します。すべてのオプションのリストについては、以下のドキュメントを参照してください。
以下をインストールの一部として Domino サーバーに追加します。
\Domino REST API JAR ファイルが含まれているフォルダ
Notes.ini の更新
ServerTasks=restapi
KeepInstallDir=C:\Domino\restapi
KeepManagementURL=http://localhost:8889
以下の 3 つの Domino データベースとそれぞれのテンプレートが Domino Data フォルダにインストールされます。
* Domino Keep 構成 (keepconfig.nsf)
* Domino Keep エージェントスケジュール (keepagents.nsf)
* Domino Keep OAuth (oauth.nsf)
注:Domino REST API のコンポーネント、設定、ログに KEEP への参照があります。
KEEP は Domino REST API の元のプロジェクト名です。
さらに、インストーラーは Domino REST API を起動し、nrestapi.exe を使用して Domino サーバー上のタスクとして実行します。
他の Domino サーバータスクと同様に、Domino サーバーコンソールで 'tell restapi action' を発行して Domino REST API と対話できます。例えば、'tell restapi help' は利用可能なアクションを出力する。
tell restapi status'を発行すると、サーバー・コンソールに restapi タスクに関する情報が書き込まれる。
この紹介を楽しみ、Domino REST API の基礎的なコンポーネントについて学んでいただけたなら幸いです。次回は、Domino REST API を適切に設定し、セキュアにするために必要な手順を学びます。