Welche REST-APIs sind in BarTender Cloud Verfügbar?
Frage
Welche APIs sind verfügbar? Was macht jede der REST-APIs?
Geeignet für
- BarTender Cloud-REST-API
- Automation Abo
Sicherheits-API
Die Sicherheits-API verwaltet alle Aspekte für Benutzer, Berechtigungen, Gruppenverwaltung und Rollenmanagement.
Sicherheitsgrundlagen
Sicherheit funktioniert in der Cloud etwas anders als in der lokalen BarTender Anwendung. Der Hauptunterschied besteht darin, dass das Konzept einer Berechtigungsverweigerung nicht existiert.
On-Prem BarTender hat das Konzept der Berchitungseinstellung Verweigern, welches alle Berechtigungseinstellungen Erlauben-für einen bestimmten Benutzer, solange diese Verweigerung vorhanden ist (unabhängig davon, ob sie von einer Gruppe stammt oder explizit für den Benutzer selbst festgelegt), überstimmt. Dies legt die effektive Berechtigung des Benutzers als Immer verweigern fest, egal ob die Berechtigung anderswo erlaubt ist.
Cloud hat keine explizite Verweigerung und funktioniert stattdessen auf einem "erlaubt" oder "nicht erlaubt"-Berechtigungssystem. Durch die Union aller Berechtigungsquellen (Rollen, Gruppen, individuelle Einstellungen), wird festgestellt ob ein Benutzer eine Aktion ausführen darf oder nicht. Wenn ein Benutzer in einer Gruppe etwas eine Erlaubnis hat, gilt diese auch wenn eine andere Gruppe des Benutzers diese Erlaubnis nicht hat. Wenn beispielsweise Benutzer A zur Dokumentenverwaltungsgruppe gehört (welche die Dokumentenverwaltung erlaubt), und auch zur Gruppe der Druckoperatoren gehört(welche nur Berechtigungen zum Drucken hat), hat Benutzer A trotzdem die Berechtigungen zum Verwalten von Dokumenten, da ein der Gruppen dies bestimmt.
Benutzerverwaltung
Die API kann Folgendes tun
- Einen Benutzer erstellen
- Einen Benutzer löschen
- Benutzerinformationen aktualisieren
Rollenverwaltung
Rollen sind im Wesentlichen Container für Berechtigungen. Diese Berechtigungen gelten für alle Benutzer, die dieser spezifischen Rolle zugewiesen sind.
Rollen werden Gruppen und Benutzern zugewiesen, um ihre Berechtigungen festzulegen. Diese Berechtigungen können verwendet werden, um Befugnisse für Dateien über die Weboberfläche oder über die API festzulegen. Sie können auch steuern, ob Benutzer oder Gruppen Zugriff auf bestimmte APIs haben.
Drucker-API
Die Drucker-API (manchmal auch als Druckverwaltungs-API bezeichnet) bezieht sich auf alles was mit Druckern zu tun hat. Dazu gehört das Abfragen angeschlossener Drucker, das Abrufen von Druckerinformationen sowie des Druckaufträgsstatus. Momentan gibt es keine API-Aufrufe zum Abfragen von Druckabläufen.
Viele der API-Aufrufe werden vom Print Controller Service verarbeitet, dieser kommuniziert mit dem Print Gateway Service, der lokal auf Client-Rechnern installiert wird.
Drucker-IDs
Drucker-IDs machen es möglich Drucker innerhalb eines Mietbereichs zu identifizieren und eindeutig zu addressieren. Jeder Drucker wird durch den Namen des Client + den Druckernamen identifiziert
- Drucker:<Client-Name>/<Druckername>
Librarian API
Die Librarian-API ist die REST-API, die mit Dateien und Ordnern arbeitet welche im Librarian-Bereich gespeichert sind. Sie können sich dies als Datei- und Ordnerverwaltung über API-Aufrufe vorstellen. Sie hat Zugriff auf beide Librarian-Bereiche und kann mit Dateien und Ordnern in beiden arbeiten. Die Librarian-API druckt keine Dokumente.
Librarian-URIs
Der Librarian-Bereich verfügt über eigene URIs, die eine Dateien oder Ordner identifizieren können sowie alle zusätzlichen Informationen, die zum Abrufen des richtigen Versionselements innerhalb des Librarian-Bereich erforderlich sind. Ausserdem kann diese feststellen in welchem Librarian-Bereich sich die Datei oder der Ordner befindet. Die URIs wird nicht nur in der Librarian-API verwendet, sondern auch in der Aktion-API, um auf beliebige Dateien zu verweisen welche im Librarian-Bereich gespeichert sind. Datei-URIs werden von beiden APIs verwendet, aber Ordner-URIs werden im Allgemeinen nur von der Librarian-API verwendet.
Die allgemeine Syntax für eine URI ist
- Librarian://<Bereich>/<Pfad>[?Parameter1=Wert1&Parameter2=Wert2]
Werte und Parameter können am Ende mit einem & verkettet werden. Der ? ist nur erforderlich, wenn Parameter vorhanden sind.
Die beiden Bereiche sind Main und $temp.
Beispiel-URIs
Main Bereich
- librarian://Main/Shipping/Label.btw
- librarian://Main/MyLabel.btw?version=3
$temp Bereich
- librarian://$temp/Work/File.txt
- librarian://$temp/label.btw
Aktions API
Die Cloud Aktions-API sendet Anweisungen an die Cloud um Druckaufträge zu automatisieren oder zu aktualisieren. Während diese der BarTender REST API ähnelt und auch ähnliche Aktionen ausführen kann, kann die Cloud API nur Aufrufe in YAML entgegennehmen und ihre Aktionen sind aus Sicherheitsgründen begrenzt, da diese in einer Cloud-Umgebung ausgeführt werden. Datenbankaktionen und Aktionen wie Execute SQL sind nicht in der API enthalten. Eine vollständige Liste finden Sie in der API-Dokumentation.
Zusätzlich zum Drucken von Etiketten kann die Aktions-API Informationen über aktuelle Aktionen abrufen sowie einige Aktionen für Ordner und Dateien ausführen. Die Ordneraktionen werden jedoch hauptsächlich von der Librarian-API ausgeführt.
Abhängigkeit von anderen APIs
Wenn Sie den genauen Standort einer Ressource oder die richtige Adresse nicht kennen, können Sie andere APIs verwenden, um die Informationen zu finden:
- Librarian-API für den Dateispeicherort
- Druck-API für den Druckernamen und Druckinformationen.
Da es sich um separate APIs handelt, müssen Sie mehrere Aufrufe ausführen, um die benötigte Information abzurufen. Wenn Sie diese Information bereits haben, können Sie sich die zusätzlichen Anrufe ersparen und sofort den Aktionsaufruf machen.