API-Schlüssel-Reiter

Die Registerkarte API-Schlüssel ist nur verfügbar, wenn für Ihr Konto ein Abonnement für RICOH Predictive Insight besteht. Um die Registerkarte anzuzeigen und mit Schlüsseln zu arbeiten, benötigen Sie einen Administrator-Zugriff auf Account Administration.

Über zwei Links oben auf der Registerkarte können Sie Referenzinformationen zur Datenexport-API aufrufen:

Erste Schritte mit API-Schlüsseln

Öffnet die Hilfe zur Datenexport-API, in der Sie nachlesen können, was Sie tun müssen, um API-Schlüssel zu verwenden, sowie Informationen zu den verfügbaren Endpunkten, den Feldern, die jeder Endpunkt zurückgibt, und den für Anfragen geltenden Beschränkungen.

API-Explorer öffnen

Öffnet die interaktive Dokumentationsseite für die API, auf der Sie die einzelnen Endpunkte einsehen, die jeweils akzeptierten Parameter anzeigen und Beispielanfragen direkt über Ihren Browser absenden können. Sie benötigen den Wert eines API-Schlüssels, um von dieser Seite aus eine Anfrage zu senden.

Die folgenden Aktionen können Sie auf diesem Reiter durchführen:

• Zeigen Sie alle für Ihr Konto definierten Schlüssel und deren Eigenschaften an, wie beispielsweise: Name, Status und Ablaufdatum.

  In der Tabelle wird der Wert eines Schlüssels nicht angezeigt.

• Erstellen Sie einen Schlüssel.

  Klicken Sie auf API-Schlüssel erstellen. Die Schlüssel sind in der Regel innerhalb von 30 Sekunden aktiv, es kann jedoch zu Verzögerungen kommen.

• Überwachen Sie die API-Anfragen des Kontos im Hinblick auf die Grenzwerte der Lizenz.

  Das Feld oberhalb der Tabelle mit den API-Schlüsseln zeigt den Nutzungsplan des Kontos sowie die maximal zulässige Anzahl an API-Aufrufen innerhalb eines Zeitraums von 30 Tagen an. Erfassen Sie, wie viele Anrufe in den letzten 30 Tagen getätigt wurden.

• Bearbeiten Sie den Namen, die Beschreibung oder das Ablaufdatum eines bestehenden Schlüssels.

  Klicken Sie mit der rechten Maustaste auf eine Zeile und wählen Sie API-Schlüssel bearbeiten. Das Bearbeiten eines Schlüssels hat keinen Einfluss auf dessen Wert, sodass Anwendungen, die diesen Schlüssel bereits verwenden, weiterhin einwandfrei funktionieren.

• Drehen Sie einen Schlüssel, um dessen Wert zu ändern.

  Klicken Sie mit der rechten Maustaste auf eine Zeile und wählen Sie API-Schlüssel rotieren. Legen Sie einen Überschneidungszeitraum fest, in dem sowohl der bisherige als auch der neue Wert für einige Tage gültig sind, damit Sie genügend Zeit haben, Ihre Anwendungen anzupassen. Der Schlüssel mit dem neuen Wert steht in der Regel innerhalb von 30 Sekunden zur Verfügung, es können jedoch Verzögerungen auftreten.

• Einen Schlüssel löschen.

  Klicken Sie mit der rechten Maustaste auf eine Zeile und wählen Sie Sofort löschen.

  Hinweis:
  • Durch das Löschen eines Schlüssels wird dieser innerhalb einer Minute aus dem System entfernt, wobei es zu Verzögerungen kommen kann. Gelöschte Schlüssel werden endgültig entfernt. Wenn Sie versuchen, eine API-Anfrage mit einem Schlüssel zu senden, nachdem dieser gelöscht wurde, schlägt die Anfrage fehl.
  • Durch das Löschen eines Schlüssels werden alle Versionen dieses Schlüssels gelöscht. Wenn Sie einen Schlüssel rotieren und anschließend löschen, werden beide Versionen des Schlüssels gelöscht, auch wenn der Überschneidungszeitraum noch aktiv ist.

Schlüssel sind nicht auf einzelne Drucker beschränkt. Jeder, der über den Wert eines Schlüssels verfügt, kann Anfragen in Ihrem Namen stellen. Geben Sie die Schlüssel ausschließlich an die Personen weiter, die an der Entwicklung von Integrationen arbeiten, und ersetzen Sie diese regelmäßig gemäß Ihren Sicherheitsrichtlinien.

Wenn Sie auf , das Werkzeugsymbol, klicken, öffnet sich ein Menü, in dem Sie die Informationen in der Tabelle aktualisieren und die Tabellenspalten verwalten können.