RICOH ProcessDirector Rest APIドキュメントを使用する

RICOH ProcessDirector は Web サービス統合用に REST API を提供するこれらの API には対話式のドキュメントが用意されており、使用可能な各 API のライブテスト機能や情報を提供します。

REST API ドキュメントには、アプリケーションで RICOH ProcessDirector への組み込みに使用できるさまざまな API が含まれています。REST API ドキュメントとテスト用インターフェースを使用して、パラメーター設定をテストできます。このインターフェースを使用して Web サービスをテストするときには、RICOH ProcessDirector 1 次サーバーにアクセスします。オブジェクトの作成、削除、および使用可能化などのアクションは 1 次サーバー上で実行されて、RICOH ProcessDirector ユーザーインターフェースに反映されます。このため、テスト専用のオブジェクトを作成することをお勧めします。

これらのステップは、REST API によってオブジェクトのログファイルを要求する方法を示します。これらのステップでは、RICOH ProcessDirector にログインし、サンプルプリンターのログファイルを要求して、ログアウトします。

  1. Web ブラウザーを開いて、RICOH ProcessDirector のホスト名または IP アドレスをアドレスバーに入力します。REST API ドキュメントにアクセスするには、ホスト名または IP アドレスの末尾に/restapi/を追加します。例: http://hostname:15080/restapi/
  2. usersセクションで POST /users/loginを見つけます。
  3. Try it Outをクリックします。
  4. RICOH ProcessDirector 資格情報を入力して RICOH ProcessDirector にログインします。
    • 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
    • pwdパラメーターには、RICOH ProcessDirector ユーザー名と関連付けられているパスワードを入力します。
  5. 実行をクリックします。
    REST API ドキュメントはユーザー入力値を使用して、build a Curl コマンドと要求 URL を構築します。さらに、要求を要求 URL に実行依頼して、ユーザーのログインを実行します。

    RICOH ProcessDirector は、ログインに成功したかどうかを示す応答を送信します。この応答には、トークンや、このユーザー ID に許可されているアクションなどの追加情報が含まれます。

  6. Response Bodyボックスで、トークン値を見つけてコピーします。

  7. objectsセクションで POST /objects/log/{objectType}/{name}を見つけるまでスクロールダウンします。
  8. Try it Outをクリックします。
  9. 次のパラメーターを入力して、サンプルプリンターのログメッセージを取得します。
    1. tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
    2. objectTypeパラメーターには、Printerと入力します。
      objectType の値は大/小文字の区別があります。Web サービスPOST /util/objecttypesを使用して、システムで使用可能なオブジェクトタイプのリストを取得します。Web サービス POST /util/objecttypesは、 utilセクションにあります。
    3. nameパラメーターには、Sampleと入力します。
  10. 実行をクリックします。
    サンプルプリンターのログエントリーは、［Response Body］ボックスに返されます。

    Curl および要求 URL の値も返されます。

  11. usersセクションで POST /users/logout/{name}を見つけます。
  12. Try it Outをクリックします。
  13. RICOH ProcessDirector からログアウトします。
    • tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
    • 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
  14. 実行をクリックします。
    RICOH ProcessDirector からログアウトしました。

  15. 値の例は、特定の API に含まれています。値の例を使用すると、サンプルコードを更新して、テスト用に変更できます。

    これらのステップは、REST API を使用してホットフォルダーを接続する方法を、値の例を用いて示します。これらのステップでは、RICOH ProcessDirector にログインし、 HotFolderPDF からのファイルを受け入れるように入力装置を設定して、ログアウトします。

  16. 上記のようにREST APIインターフェースを開きます。
  17. usersセクションで POST /users/loginを見つけます。
  18. Try it Outをクリックします。
  19. RICOH ProcessDirector 資格情報を入力して RICOH ProcessDirector にログインします。
    • 名前パラメーターには、ユーザー名を入力します。
    • pwdパラメーターには、ユーザー名と関連付けられているパスワードを入力します。
  20. 実行をクリックします。
  21. Response Bodyボックスで、トークン値を見つけてコピーします。
  22. objectsセクションで POST /objects/{objectType}/connectを見つけるまでスクロールダウンします。
  23. Try it Outをクリックします。
  24. これらのパラメーターを入力して、HotFolderPDFを接続します。
    1. tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
    2. objectTypeパラメーターには、InputDeviceと入力します。
      objectType の値は大/小文字の区別があります。Web サービスPOST /util/objecttypesを使用して、システムで使用可能なオブジェクトタイプのリストを取得します。Web サービス POST /util/objecttypesは、 utilセクションにあります。
    3. bodyパラメーターには、Edit Valueをクリックします。例文がコードボックスに表示されます。"string"という単語を"HotFolderPDF"で置き換えます。オブジェクトの名前は二重引用符で囲んでください。
  25. 実行をクリックします。
    HotFolderPDF のプロパティーおよび設定は、［Response Body］ボックスに返されます。［Response Code］および［Response Headers］も返されます。
  26. usersセクションで POST /users/logout/{name}を見つけます。
  27. Try it Outをクリックします。
  28. RICOH ProcessDirector からログアウトします。
    • tokenパラメーターには、上の手順でコピーしたトークンを貼り付けます。
    • 名前 パラメーターには、RICOH ProcessDirector ユーザー名を入力します。
  29. 実行をクリックします。
    RICOH ProcessDirector からログアウトしました。

Related information:

Webサービスを使用してジョブの実行依頼を準備する
上位層のトピック： RICOH ProcessDirector の Web サービス