API-Schlüssel

Ein API-Schlüssel ist eine Anmeldeinformation, die es einer Anwendung ermöglicht, im Namen Ihres Kontos Anfragen an eine RICOH TotalFlow Cloud-API zu senden. Sie definieren API-Schlüssel unter RICOH Account Administration.

Anwendungen, die anstelle der Benutzeroberfläche eine API verwenden, können sich nicht als Benutzer anmelden. Stattdessen enthält jede Anfrage den Wert eines API-Schlüssels, der das Konto identifiziert, zu dem die Anfrage gehört. Da der Schlüssel Ihre Kontoidentität enthält, müssen in Anfragen keine Parameter für das Konto oder den Mandanten angegeben werden.

Sie können bis zu zehn Schlüssel für Ihr Konto festlegen. Viele Organisationen erstellen für jede Anwendung, die Daten abruft, einen eigenen Schlüssel, sodass ein Schlüssel ersetzt oder gelöscht werden kann, ohne dass die anderen Anwendungen davon beeinträchtigt werden. Jeder Schlüssel verfügt über einen Namen, eine Beschreibung und ein Ablaufdatum.

Der Wert eines Schlüssels wird nur einmal angezeigt, und zwar in dem Moment, in dem Sie den Schlüssel erstellen oder rotieren. Account Administration speichert den Wert nicht in einer Form, die erneut angezeigt werden kann; daher müssen Sie ihn kopieren und sicher aufbewahren, sobald er angezeigt wird. Sollte ein Wert verloren gehen, drehen Sie den Schlüssel, um einen neuen zu generieren. Jeder, der über diesen Wert verfügt, kann in Ihrem Namen Anfragen stellen; schützen Sie Ihre Schlüssel daher genauso wie ein Kennwort. Schlüssel sind nicht auf bestimmte Drucker beschränkt.

Die Schlüssel werden auf der Registerkarte API-Schlüssel verwaltet. Sie können den Namen, die Beschreibung oder das Ablaufdatum eines Schlüssels ändern; einen Schlüssel rotieren, um dessen Wert zu ersetzen und dabei dessen Identität beizubehalten; oder einen Schlüssel löschen, um den Zugriff sofort zu widerrufen.

Unter RICOH TotalFlow Cloud werden API-Schlüssel in Verbindung mit der Datenexport-API verwendet, die Informationen zu Druckern, Jobs und dem Druckerstatus abruft, die von RICOH Predictive Insight erfasst wurden. Die Anzahl der API-Anfragen, die Ihr Konto über alle API-Schlüssel hinweg stellen kann, richtet sich nach Ihrem Abonnement. Für jedes Abonnement gilt eine Obergrenze für die Anzahl der API-Anfragen, die innerhalb eines rollierenden Zeitraums von 30 Tagen zulässig sind. Sollten Sie die in Ihrem Abonnement gewährte Anzahl an Aufrufen überschreiten, werden keine Anfragen mehr angenommen, bis die Gesamtzahl der Anfragen der letzten 30 Tage unter das Abonnementlimit fällt. Um zu erfahren, wie viele Anrufe Ihr Abonnement umfasst und wie viele Sie in den letzten 30 Tagen getätigt haben, besuchen Sie bitte die Seite API-Schlüssel. Sollten Sie feststellen, dass Sie mehr Kapazität für API-Anfragen benötigen, wenden Sie sich bitte an Ihren Ricoh-Ansprechpartner, um eine Erweiterung Ihres Abonnements zu besprechen.