Data Export API を試してみる

インタラクティブなドキュメントページを参考に、API の概要を簡単に理解するには、以下の手順に従ってください。

この作業を開始する前に、RICOH Account Administration を使用して APIキーを作成してください。

この手順では、以下の内容について順を追って説明します：

  1. 対話型ドキュメントページの認証
  2. アカウントに登録されているプリンターのID一覧を取得する
  3. 1台または複数のプリンタのステータスを取得する
  4. それらのプリンタのうち1台以上に関連するジョブに関する情報をリクエストします

Data Export API を使用するには:

  1. Data Export API の対話型ドキュメントをこちらで開きます。
  2. APIキーを使用して認証を行うには：
    1. ページの右側にある承認をクリックしてください。
    2. 利用可能な認証 ダイアログで、値 フィールドに APIキーを入力してください。
      利用可能な認証ダイアログ
    1. 承認をクリックして認証を行ってください。
    2. 閉じるをクリックします。
    これで、利用可能なAPI機能をテストできるようになりました。APIをアプリケーションに組み込む前に、このインターフェースを使用して構文に慣れておいてください。
  3. アカウントで定義されているプリンターのID一覧を取得します。
    ジョブおよびプリンタのステータス情報を取得するには、APIリクエストにプリンタIDの値を指定する必要があります。プリンターIDは変更されません。今すぐそれらを取得して値を保存しておけば、他のAPI呼び出しでそのIDを利用することができます。
    1. プリンターセクションを開き、次に GET /printersエンドポイントを開いてください。
      このエンドポイントにはパラメータが不要であることがお分かりいただけると思います。
    2. 試してみるをクリックし、次に 実行をクリックしてください。
    3. レスポンス本文を確認してください。RICOH Predictive Insight によって監視されているプリンターに関する詳細の一覧が表示されます。応答は次のようなものになります：
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      お使いの各プリンターについて、printerIdパラメータの値を記録してください。

  4. システム内の1台または複数のプリンターについて、プリンターの状態履歴を取得してください。
    1. GET /printer-statesエンドポイントを開いてください。
    2. 試してみるをクリックします。
    3. printerIdの横にある 文字列項目を追加をクリックしてください。
    4. このフィールドのテキストを、手順 で取得したプリンターIDのいずれかに置き換えてください。
      その他のプリンターのステータス履歴を取得するには、もう一度文字列項目を追加をクリックし、別のプリンターIDの値を追加してください。
    5. タイムゾーンについては、データに使用するタイムゾーンを選択してください。
    6. レポートの対象となる期間の開始時刻と終了時刻を指定してください。過去24時間のデータを取得するには、これらの値を空白のままにしてください。
    7. 最後の3つの値はデフォルトのままにしておくと、APIが返すことができる情報の全リストを確認できます。
    8. 実行をクリックします。
    9. レスポンス本文を確認してください。各プリンターエンジンのプリンター状態データの一覧が表示されます。プリンター状態が変更されるたびに、1 つのスタンザが表示されます。
    10. currentState、 stateCategoryOnly、 stateCategoryの各パラメータの値を変更し、もう一度 実行をクリックして、レスポンスがどのように変化するかを確認してください。
      • これらのパラメータをデフォルト（未設定）のままにしておくと、しない に設定した場合と同じ効果になります。
      • これらは単独で、あるいは組み合わせてお使いいただけます。
  5. これらのプリンターのうち1台以上に関連するジョブに関する情報をリクエストしてください：
    1. ページのジョブセクションを開きます。
    2. GET /jobs エンドポイントを開きます。
    3. 試してみるをクリックします。
    4. printerIdの横にある 文字列項目を追加をクリックしてください。
    5. このフィールドのテキストを、手順 で取得したプリンターIDのいずれかに置き換えてください。
      その他のプリンターのジョブ情報を取得するには、もう一度文字列項目を追加をクリックし、別のプリンターIDの値を追加してください。
    6. タイムゾーンについては、データに使用するタイムゾーンを選択してください。
    7. レポートの対象となる期間の開始時刻と終了時刻を指定してください。過去24時間のデータを取得するには、これらの値を空白のままにしてください。
    8. jobState については、API が返すことのできる回答の全範囲を確認するには、値を空白のままにしてください。
    9. 実行をクリックします。
    10. レスポンスを確認して、返されたジョブ情報をご確認ください。
    11. jobStateの値を変更し、もう一度 実行をクリックして、レスポンスがどのように変化するかを確認してください。
上位層のトピック： データエクスポートAPIの活用