データエクスポートAPI

データエクスポートAPIは、4つのエンドポイントを提供するREST APIです。これらのエンドポイントを使用すると、お使いのプリンターに関する情報や、プリンターが処理したジョブ、さらにプリンターの経時的な動作状態、およびプリンターで警告やエラーメッセージが発生した原因となったイベントなどを取得することができます。

Data Export API を使用すると、RICOH Predictive Insightのデータを、組織内のビジネスインテリジェンスツール、データウェアハウス、ダッシュボード、その他のアプリケーションに取り込むことができます。

認証

APIキーの作成と管理は、RICOH Account Administration で行います。必要なだけキーを作成することができます。データをダウンロードするアプリケーションごとに1つずつ作成してもよいですし、組織全体で共有して1つのキーを使用しても構いません。セキュリティ対策の方針に従って有効期限を設定し、必要に応じて鍵を更新してください。重複期間を設定することができますので、新旧の鍵が数日間は両方とも使用できるようになります。必要に応じて、キーを削除することで、そのキーを直ちに無効にすることができます。

APIキーにはテナントIDも含まれているため、どのリクエストにおいてもテナントやアカウントのパラメータを指定する必要はありません。キーの値を知っている人なら誰でも、あなたのテナントとしてリクエストを送信することができますので、APIキーはパスワードと同じように厳重に管理してください。

利用可能なエンドポイント

このAPIには、以下のエンドポイントが含まれています：

/printers
アカウントに登録されているプリンターのリストを返します。このリストには、プリンター名、モデル、メーカー、シリアル番号、エンジン、および現在の接続状況が含まれます。
/jobs
1台または複数のプリンターに関するジョブレベルの詳細情報を返します。これには、処理時間、印刷部数、ページ数、インプレッション数、シート数、ロール長、およびカラーチャネルごとのインク使用量とフラッシングの使用量が含まれます。デフォルトでは、応答の対象は過去24時間分となります。
/printer-states
各プリンターエンジンの動作状態を、指定した期間の集計履歴として、あるいは現在の状態のみとして返します。Printing、Preparing、Maintenance、Sleepingといったプリンターの実際の状態を取得できるほか、これらの状態をup、down、idle、unklnownといったカテゴリに分類することも可能です。

ヒント: /printer-statesエンドポイントは、プリンター全体ではなく、プリンターエンジンごとの状態情報を報告します。複数のエンジンを備えたプリンターは、エンジンごとに1行ずつ出力します。

/printer-interventions
1台以上のプリンターで発生した、紙詰まりや用紙切れなどの警告やエラーの原因となったイベントを返します。各イベントは、1つのプリンターエンジンごとに、開始時刻、終了時刻、継続時間、条件を識別するコード、および印刷中のジョブ名（ある場合）とともに報告されます。デフォルトでは、応答の対象は過去24時間分となります。対応している言語のいずれかで、イベントの概要をご請求いただけます。

APIのテスト

各エンドポイントの確認や、受け付けるパラメータの確認、さらにはブラウザから直接サンプルリクエストを試すことができる、インタラクティブなドキュメントページをご用意しております。ページを開くには、以下のURLにアクセスしてください：

ドキュメントページやご自身のアプリケーションからリクエストを送信するには、まずAPIキーを作成する必要があります。APIキーの作成と管理は、Account Administration で行います。

上位層のトピック： データエクスポートAPIの活用