Arbeiten mit der Datenexport-API

Mithilfe der Datenexport-API können Sie die von RICOH Predictive Insight erfassten Informationen extrahieren, um sie in anderen Prozessen und Tools Ihres Unternehmens zu nutzen.

Die Datenexport-API ermöglicht den programmgesteuerten Zugriff auf Druckerinformationen, die Jobs, Daten zum Druckerstatus sowie Ereignisse im Zusammenhang mit Eingriffen am Drucker. Sie können damit Berichtstools mit Daten versorgen, Dashboards befüllen, Betriebsdaten archivieren oder Daten aus RICOH Predictive Insight in andere Systeme Ihrer Umgebung integrieren.

In this section:

  1. 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.
  2. Erstellen und Verwalten von API-Schlüsseln
    Ein API-Schlüssel autorisiert Anfragen an die Datenexport-API. Sie erstellen und verwalten API-Schlüssel unter Account Administration und geben den Schlüssel an, wenn Sie Anfragen über die Seite „API-Explorer“ oder aus Ihren eigenen Anwendungen absenden.
  3. Die Datenexport-API ausprobieren
    Befolgen Sie diese Anleitung, um sich einen kurzen Überblick über die API zu verschaffen, und nutzen Sie dabei die interaktive Dokumentationsseite als Leitfaden.
  4. Umgang mit Datum und Uhrzeit in der Datenexport-API
    Die Datenexport-API verwendet ein einheitliches Modell für die Verarbeitung von Datums- und Zeitangaben: Jede Anfrage enthält eine IANA-Zeitzone, jeder Datums- und Zeitwert wird in dieser Zeitzone interpretiert, und jeder Datums- und Zeitwert in der Antwort wird in derselben Zeitzone formatiert. Nutzen Sie dieses Thema, um die Funktionsweise des Modells zu verstehen und häufige Fehler zu vermeiden.
  5. Feldnamen der Antwort der Datenexport-API
    Jeder Endpunkt der Datenexport-API gibt ein JSON-Array aus Objekten zurück. Verwenden Sie die Tabellen in diesem Abschnitt, um die Felder in den einzelnen Antworten zu interpretieren.
  6. Beispiele für Anfragen und Antworten der Datenexport-API
    Nutzen Sie die Beispiele in diesem Abschnitt als Ausgangspunkt für Ihre eigene Integration. Jedes Beispiel zeigt eine repräsentative Anfrage-URL zusammen mit dem Antworttext, den die API zurückgibt.
  7. Fehlerbehebung bei der Datenexport-API
    Nutzen Sie diesen Abschnitt, um häufige Fehlermeldungen der Datenexport-API zu interpretieren und für jede einzelne die wahrscheinlichste Ursache sowie die entsprechende Abhilfe zu ermitteln. Jede Fehlermeldung enthält einen code, eine message und einen numerischen statusCode; der code-Wert gibt die jeweilige Bedingung an.

Related information:

Erstellen und Verwalten von API-Schlüsseln
API-Schlüssel-Reiter
API-Schlüssel
Übergeordnetes Thema: RICOH Account Administration