RICOH ProcessDirector Rest APIドキュメントを使用する
REST API ドキュメントには、アプリケーションで RICOH ProcessDirector への組み込みに使用できるさまざまな API が含まれています。REST API ドキュメントとテスト用インターフェースを使用して、パラメーター設定をテストできます。このインターフェースを使用して Web サービスをテストするときには、RICOH ProcessDirector 1 次サーバーにアクセスします。オブジェクトの作成、削除、および使用可能化などのアクションは 1 次サーバー上で実行されて、RICOH ProcessDirector ユーザーインターフェースに反映されます。このため、テスト専用のオブジェクトを作成することをお勧めします。
これらのステップは、REST API によってオブジェクトのログファイルを要求する方法を示します。これらのステップでは、RICOH ProcessDirector にログインし、サンプルプリンターのログファイルを要求して、ログアウトします。
- Web ブラウザーを開いて、RICOH ProcessDirector のホスト名または IP アドレスをアドレスバーに入力します。REST API ドキュメントにアクセスするには、ホスト名または IP アドレスの末尾に/restapi/を追加します。例: http://hostname:15080/restapi/
- usersセクションで、 Expand Operationsをクリックして、 GET /users/loginを見つけます。
- RICOH ProcessDirector 資格情報を入力して RICOH ProcessDirector にログインします。
- 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
- pwdパラメーターには、RICOH ProcessDirector ユーザー名と関連付けられているパスワードを入力します。
- Try it Out!をクリックします。REST API ドキュメントはユーザー入力値を使用して、build a Curl コマンドと要求 URL を構築します。さらに、要求を要求 URL に実行依頼して、ユーザーのログインを実行します。
RICOH ProcessDirector は、ログインに成功したかどうかを示す応答を送信します。この応答には、トークンや、このユーザー ID に許可されているアクションなどの追加情報が含まれます。
- Response Bodyボックスで、トークン値を見つけてコピーします。
- objectsセクションで、 Expand Operationsをクリックします。 GET /objects/log/{objectType}/{name}を見つけるまでスクロールダウンします。
- 次のパラメーターを入力して、サンプルプリンターのログメッセージを取得します。
- tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
- objectTypeパラメーターには、Printerと入力します。
- objectType の値は大/小文字の区別があります。Web サービスGET /util/objecttypesを使用して、システムで使用可能なオブジェクトタイプのリストを取得します。Web サービス GET /util/objecttypesは、 utilセクションにあります。
- nameパラメーターには、Sampleと入力します。
- Try it Out!をクリックします。サンプルプリンターのログエントリーは、［Response Body］ボックスに返されます。
Curl および要求 URL の値も返されます。
- usersセクションで、 Expand Operationsをクリックして、 POST /users/logout/{name}を見つけます。
- RICOH ProcessDirector からログアウトします。
- tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
- 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
- Try it Out!をクリックします。RICOH ProcessDirector からログアウトしました。
-
値の例は、特定の API に含まれています。値の例を使用すると、コードのサンプルストリングをボディーフィールドにコピーして、テスト用に変更できます。
これらのステップは、REST API を使用してホットフォルダーを接続する方法を示しています。これらのステップでは、RICOH ProcessDirector にログインし、 HotFolderPDF からのファイルを受け入れるように入力装置を設定して、ログアウトします。
- Web ブラウザーを開いて、RICOH ProcessDirector のホスト名または IP アドレスをアドレスバーに入力します。REST API ドキュメントにアクセスするには、ホスト名または IP アドレスの末尾に/restapi/を追加します。例: http://hostname:15080/restapi/
- usersセクションで、 Expand Operationsをクリックして、 GET /users/loginを見つけます。
- RICOH ProcessDirector 資格情報を入力して RICOH ProcessDirector にログインします。
- 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
- pwdパラメーターには、RICOH ProcessDirector ユーザー名と関連付けられているパスワードを入力します。
- Try it Out!をクリックします。REST API ドキュメントはユーザー入力値を使用して、build a Curl コマンドと要求 URL を構築します。さらに、要求を要求 URL に実行依頼して、ユーザーのログインを実行します。
RICOH ProcessDirector は、ログインに成功したかどうかを示す応答を送信します。この応答には、トークンや、このユーザー ID に許可されているアクションなどの追加情報が含まれます。
- Response Bodyボックスで、トークン値を見つけてコピーします。
- objectsセクションで、 Expand Operationsをクリックします。 POST /objects/{objectType}/connectを見つけるまでスクロールダウンします。
- これらのパラメーターを入力して、HotFolderPDFを接続します。
- tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
- objectTypeパラメーターには、InputDeviceと入力します。objectType の値は大/小文字の区別があります。Web サービスGET /util/objecttypesを使用して、システムで使用可能なオブジェクトタイプのリストを取得します。Web サービス GET /util/objecttypesは、 utilセクションにあります。
- ［body］パラメーターには、［Example Value］をクリックします。［Example Value］内のテキストが［body］パラメーターにコピーされます。"string"という単語を"HotFolderPDF"で置き換えます。オブジェクトの名前は二重引用符で囲んでください。
- Try it Out!をクリックします。HotFolderPDF のプロパティーおよび設定は、［Response Body］ボックスに返されます。［Response Code］および［Response Headers］も返されます。
- usersセクションで、 Expand Operationsをクリックして、 POST /users/logout/{name}を見つけます。
- RICOH ProcessDirector からログアウトします。
- tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
- 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
- Try it Out!をクリックします。RICOH ProcessDirector からログアウトしました。