Datenexport-API

Die Datenexport-API ist eine REST-API, die vier Endpunkte bereitstellt. Über diese Endpunkte können Sie Informationen zu Ihren Druckern und den von ihnen verarbeiteten Jobs sowie zu den Betriebszuständen dieser Drucker im Zeitverlauf und zu Ereignissen abrufen, die Warn- oder Fehlermeldungen am Drucker ausgelöst haben.

Mithilfe der Datenexport-API können Sie Daten aus RICOH Predictive Insight in Business-Intelligence-Tools, Data Warehouses, Dashboards und andere Anwendungen in Ihrem Unternehmen übertragen.

Authentifizierung

Sie erstellen und verwalten API-Schlüssel unter RICOH Account Administration. Sie können so viele Schlüssel erstellen, wie Sie benötigen: einen pro Anwendung, die Daten herunterlädt, oder einen Schlüssel, der unternehmensweit verwendet werden kann. Legen Sie das Ablaufdatum entsprechend Ihren Sicherheitsrichtlinien fest und wechseln Sie die Schlüssel bei Bedarf aus. Sie können den Überlappungszeitraum festlegen, sodass der alte und der neue Schlüssel noch einige Tage lang beide funktionieren. Bei Bedarf können Sie einen Schlüssel löschen, um ihn sofort zu deaktivieren.

Der API-Schlüssel enthält zudem Ihre Mandanten-ID, weshalb bei keiner Anfrage ein Mandanten- oder Kontoparameter erforderlich ist. Jeder, der über den Schlüsselwert verfügt, kann Anfragen in Ihrem Namen absenden; schützen Sie API-Schlüssel daher genauso, wie Sie ein Kennwort schützen würden.

Verfügbare Endpunkte

Die API umfasst die folgenden Endpunkte:

/printers

Gibt die Liste der Drucker in Ihrem Konto zurück, einschließlich Druckername, Modell, Hersteller, Seriennummer, Druckwerke und aktueller Status der Verbindung.

/jobs

Gibt Details auf Ebene der Jobs für einen oder mehrere Drucker zurück, darunter Zeitangaben, gedruckte Exemplare, Seiten, Drucke, Bögen, Rollenlänge sowie den Tinten- und Spülmittelverbrauch nach Farbkanal. Standardmäßig umfasst die Antwort die letzten 24 Stunden.

/printer-states

Gibt den Betriebsstatus jeder Drucker-Engine zurück, entweder als aggregierte Historie über einen bestimmten Zeitraum oder ausschließlich als aktueller Status. Sie können den aktuellen Status des Druckers abrufen, beispielsweise: Drucken, Vorbereiten, Wartung oder Ruhezustand, oder diese Status können in folgende Kategorien zusammengefasst werden: up, down, idle oder unkown.

Tipp: Der Endpunkt /printer-states liefert Statusinformationen pro Drucker-engine und nicht pro Drucker. Ein Drucker mit mehreren Modulen gibt pro Modul eine Zeile aus.

/printer-interventions

Gibt die Ereignisse zurück, die auf einem oder mehreren Druckern zu Warnungen oder Fehlern geführt haben, wie beispielsweise einen Papierstau oder eine leere Medienquelle. Jedes Ereignis wird für eine einzelne Drucker-Engine erfasst, einschließlich des Startzeitpunkts, des Endzeitpunkts, der Dauer, eines Codes zur Identifizierung der Bedingung sowie gegebenenfalls des Namens des Jobs, der gerade gedruckt wurde. Standardmäßig umfasst die Antwort die letzten 24 Stunden. Sie können Veranstaltungsbeschreibungen in jeder der unterstützten Sprachen anfordern.

Testen der API

Es steht eine interaktive Dokumentationsseite zur Verfügung, auf der Sie die einzelnen Endpunkte einsehen, die unterstützten Parameter überprüfen und Beispielanfragen direkt in Ihrem Browser ausprobieren können. Um die Seite zu öffnen, rufen Sie folgende Adresse auf:

USA und Japan: https://rpi-data-export.app-ricohsoftware.com/api/v1/api-docs
Europa: https://rpi-data-export.app-ricohsoftware.eu/api/v1/api-docs

Um Anfragen über die Dokumentationsseite oder aus Ihren eigenen Anwendungen zu senden, müssen Sie zunächst einen API-Schlüssel erstellen. Sie erstellen und verwalten API-Schlüssel unter Account Administration.