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.

Bevor Sie mit dieser Aufgabe beginnen, erstellen Sie bitte einen API-Schlüssel unter RICOH Account Administration.

Diese Anleitung führt Sie durch folgende Schritte:

  1. Authentifizierung auf der Seite mit der interaktiven Dokumentation
  2. Abrufen der Liste der Drucker-IDs für die Drucker in Ihrem Konto
  3. Den Status eines oder mehrerer Drucker abrufen
  4. Anforderung von Informationen zu Jobs, die mit einem oder mehreren dieser Drucker verbunden sind

So nutzen Sie die Datenexport-API:

  1. Öffnen Sie hier die interaktive Dokumentation zur Datenexport-API:
  2. Authentifizierung mithilfe eines API-Schlüssels:
    1. Klicken Sie auf der rechten Seite auf Autorisieren.
    2. Geben Sie im Dialogfeld Verfügbare Berechtigungen Ihren API-Schlüssel in das Feld Wert ein.
      Dialogfeld Verfügbare Berechtigungen
    1. Klicken Sie auf Autorisieren, um sich zu authentifizieren.
    2. Klicken Sie auf Close.
    Sie können nun die verfügbaren API-Funktionen testen. Nutzen Sie diese Schnittstelle, um sich mit der Syntax vertraut zu machen, bevor Sie die API in Ihre Anwendungen integrieren.
  3. Rufen Sie die Liste der Drucker-IDs für die in Ihrem Konto definierten Drucker ab.
    Um Informationen zum Status der Jobs und des Druckers abzurufen, müssen Sie in Ihren API-Anfragen die Drucker-ID-Werte angeben. Drucker-IDs ändern sich nicht. Wenn Sie diese nun abrufen und die Werte speichern, können Sie die IDs in anderen API-Aufrufen verwenden.
    1. Öffnen Sie den Abschnitt Drucker und anschließend den Endpunkt GET /printers.
      Sie sehen, dass für diesen Endpunkt keine Parameter erforderlich sind.
    2. Klicken Sie auf Ausprobieren und anschließend auf Ausführen.
    3. Überprüfen Sie den Antworttext. Sie sehen eine Liste mit Details zu den Druckern, die von RICOH Predictive Insight überwacht werden. Die Antwort sieht in etwa so aus:
      [
  {
    "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"
  }
]

      Notieren Sie sich die Werte der printerId-Parameter für jeden Ihrer Drucker.

  4. Fordern Sie den Druckerstatusverlauf für einen oder mehrere Drucker in Ihrem System an.
    1. Rufen Sie den Endpunkt GET /printer-states auf.
    2. Klicken Sie auf Probieren Sie es aus.
    3. Klicken Sie neben printerId auf Zeichenfolgenelement hinzufügen.
    4. Ersetzen Sie den Text in dem Feld durch einen der Drucker-ID-Werte, die Sie in Schritt abgerufen haben.
      Um den Statusverlauf für weitere Drucker abzurufen, klicken Sie erneut auf Zeichenfolgenelement hinzufügen und fügen Sie einen weiteren Drucker-ID-Wert hinzu.
    5. Wählen Sie unter Zeitzone die Zeitzone aus, die für die Daten verwendet werden soll.
    6. Geben Sie die Start- und Endzeit für den Zeitbereich an, für den der Bericht erstellt werden soll. Lassen Sie diese Felder leer, um Daten der letzten 24 Stunden abzurufen.
    7. Lassen Sie die letzten drei Werte auf den Standardwerten stehen, damit Sie die vollständige Liste der Informationen sehen können, die die API zurückgeben kann.
    8. Klicken Sie auf Ausführen.
    9. Überprüfen Sie den Antworttext. Sie sehen eine Liste mit Daten zum Druckerstatus für jede Drucker-Engine, wobei jeder Statuswechsel durch einen eigenen Eintrag dargestellt wird.
    10. Ändern Sie die Werte für die Parameter currentState, stateCategoryOnly und stateCategory und klicken Sie erneut auf Ausführen, um zu sehen, wie sich die Antwort ändert.
      • Wenn Sie diese Parameter auf den Standardwert (nicht gesetzt) belassen, hat dies denselben Effekt wie die Einstellung auf falsch.
      • Sie können diese einzeln oder in Kombination miteinander verwenden.
  5. Fordern Sie Informationen zu den Jobs an, die mit einem oder mehreren dieser Drucker verbunden sind:
    1. Rufen Sie den Bereich Jobs auf dieser Seite auf.
    2. Rufen Sie den Endpunkt GET /jobs auf.
    3. Klicken Sie auf Probieren Sie es aus.
    4. Klicken Sie neben printerId auf Zeichenfolgenelement hinzufügen.
    5. Ersetzen Sie den Text in dem Feld durch einen der Drucker-ID-Werte, die Sie in Schritt abgerufen haben.
      Um Jobinformationen für weitere Drucker abzurufen, klicken Sie erneut auf Zeichenfolgenelement hinzufügen und fügen Sie einen weiteren Drucker-ID-Wert hinzu.
    6. Wählen Sie unter Zeitzone die Zeitzone aus, die für die Daten verwendet werden soll.
    7. Geben Sie die Start- und Endzeit für den Zeitbereich an, für den der Bericht erstellt werden soll. Lassen Sie diese Felder leer, um Daten der letzten 24 Stunden abzurufen.
    8. Lassen Sie das Feld Jobstatus leer, um die gesamte Bandbreite der Antworten anzuzeigen, die die API zurückgeben kann.
    9. Klicken Sie auf Ausführen.
    10. Überprüfen Sie die Antwort, um die zurückgegebenen Jobinformationen anzuzeigen.
    11. Ändern Sie den Wert für Jobstatus und klicken Sie erneut auf Ausführen, um zu sehen, wie sich die Antwort ändert.
Übergeordnetes Thema: Arbeiten mit der Datenexport-API