(Letzte Änderung dieses Kapitels: 30.03.2023)
Die steadyPRINT API dient als Schnittstelle, um Daten zu beziehen und Funktionen bereitzustellen. Sie ist für das WebCenter sowie SecurePrint erforderlich.
Die API ist vom steadyPRINT AD-Service abhängig, der bei der Installation der API automatisch mit installiert wird.
Mit der steadyPRINT API können Sie Daten aus steadyPRINT beziehen oder diese schreiben und steadyPRINT mit Ihrer bestehenden Infrastruktur kombinieren. Alle Funktionen im steadyPRINT Webcenter/SecurePrint sind ohne User Interface über die API realisierbar.
Für die Verwendung der API ist ein Json Web Token erforderlich. Diesen können Sie über den Login oder die Tokenverwaltung in den WebCenter-Einstellungen beziehen. Die Zugriffsrechte für das steadyPRINT Webcenter/SecurePrint lassen sich auch für die API anwenden.
Ist die steadyPRINT API installiert, können Sie eine detaillierte Auflistung der aktuellen Funktionen, welche die API bereitstellt, in der mitgeliefertetn interaktiven API Dokumentation einsehen. Die Dokumentation befindet sich bei einer lokalen Installation unter:
https://localhost:7042/docs/index.html
Ihre Konfiguration kann abhängig von der eingestellten URL und dem Port abweichen. Die URL wird nach folgendem Schema generiert:
https://computername:Port/docs/index.html
Die Dokumentation beschreibt alle existierenden Endpunkte, und Sie können diese direkt über die Web-Oberfläche ausprobieren.
Warnung |
Verwendung der Produktiven Datenbank zum Testen der API |
|
Wenn Sie Änderungen vorhnehmen, wie beispielweise das Löschen von Druckern oder das Umbenennen von Ordnern, werden diese in der steadyPRINT Umgebung ausgeführt. Es empfielt sich zum Testen der API entweder nur lesende Zugriffe zu testen oder eine Test-Datenbank zu verwenden. |
Zum Erstellen eines Tokens können Sie den Login verwenden oder einen Service-Token über die Einstellungen im WebCenter erstellen. Der Token ist erforderlich, um autorisierte Endpunkte der API aufrufen zu können.
Verwenden Sie beispielsweise den Endpunkt /api/Auth/Login und geben Sie Ihren Benutzernamen und Ihr Passwort ein, um einen Token zu erzeugen. Dieser Token kann dann verwendet werden, um andere Endpunkte aufzurufen, für die der Benutzer autorisiert ist.
Den erzeugten Token können Sie in der Web-Oberfläche hinterlegen, indem Sie auf den Authorize-Button klicken.
Nun können Sie die API erforschen und alle Endpunkte verwenden, die für diesen Benutzer zur Verfügung stehen.
Hinweis |
Gültigkeit des Tokens |
|
Der hier beschriebene Weg, einen Token zu erzeugen, ist derselbe, wie er im steadyPRINT WebCenter genutzt wird. Dieser Token hat eine Gültigkeit von 60 Minuten. Um einen Token zu erzeugen, der für einen Service oder eine 3rd Party Applikation verwendet werden kann, lesen Sie bitte im installierten WebCenter in den Einstellungen das Kapitel zu den Service-Token ( ....). |