BarTender Cloud-REST-API-Anwendungstypen
Frage
Welche Arten von Anwendungen können RESTful-Aufrufe an die REST-API senden? Was sind die Unterschiede?
Geeignet für
- BarTender Cloud-REST-API
- Automation Abos
Antwort
Bei REST-API-Aufrufen muss die Anwendung ein Token präsentieren damit diese autorisiert wird und das API Gateway nachfolgend die Aufrufe verarbeiten kann. Obwohl beide Anwendungstypen Tokens verwenden um das Sicherheitsportal zu passieren, unterscheidet sich für beide die Art und Weise um das Token zu erhalten.
Die zwei Anwendungsarten sind:
- Private/direkte Anwendungen – Insomnia, Postman usw.
- Webanwendungen - benutzerdefinierte Anwendungen
Private Anwendungen
Private Anwendungen, manchmal auch direkte Anwendungen genannt, senden einen API-Aufruf direkt an die REST-API und führen keine zusätzlichen Aufrufe außerhalb dieser API Anrufe aus. Anwendungen wie Insomnia und Postman fallen in diese Kategorie.
Eine direkte Anwendung verwendet ein Token, um das Sicherheitsportal zu passieren und API-Aufrufe zu tätigen.
Der Token muss manuell von der Weboberfläche der Cloud abgerufen werden und kann im Abschnitt „Cloud-API“ in Ihren Profileinstellungen oder unter „Cloud-Konto verwalten“ gefunden werden:
Bei direkten Anwendungen muss das Sicherheitstoken mit allen API-Aufrufen gesendet werden. In Insomnia beispielsweise kann der Auth-Tab das Token beinhalten. Das Token wird als Träger-Token (ein Autorisierungs-Token, das vom Nachrichtenträger bspw. Insomnia übergeben wird) aufgelistet. Sobald Sie die Token-Option ausgewählt haben, fügen Sie Ihr Token ein und es wird zusammen mit der API-Nachricht übergeben.
Webanwendungen
Webanwendungen werden in Sprachen wie C# erstellt und fungieren als voll funktionsfähige Benutzeroberfläche. Sie ermöglichen Benutzerinteraktionen, einschließlich der Anmeldung zur Authentifizierung für Cloud. Diese Anwendungstypen benötigen zusätzliche Schritte zum Abrufen eines Tokens um das Sicherheitsportal zu durchschreiten und API-Aufrufe tätigen zu können. Nachfolgend finden Sie eine Übersicht des Autorisierungsprozesses.
Warum sollten Sie, trotz der vielen zusätzlichen Schritte, diesen Anwendungstyp einer direkten Anwendung vorziehen? Der Authentifizierungsprozess mit dem OAuth-Identitätsanbieter aktualisiert die Sicherheit Token bei jeder Anmeldung und der Benutzer muss sich nie direkt mit Token befassen. Alles wird von OAuth und der Anwendung selbst gehandhabt. Sobald die Anwendung ein gültiges Token besitzt, kann es mit dem Senden von API-Aufrufen beginnen und das Sicherheitsportal passieren.
Webanwendungen müssen in der Cloud selbst registriert werden. Dies stellt sicher, dass nur autorisierte Anwendungen auf die Cloud zugreifen können. jedweder unautorisiertem Zugriff wird der Zugang verweigert. Die Registrierung kann über die Cloud-Weboberfläche, im Abschnitt Cloud-API in Ihren Benutzerprofileinstellungen oder unter Cloud-Konto verwalten, getätigt werden.
Bei der Registrierung einer Webanwendung werden Ihnen eine Reihe von Fragen bezüglich der Anwendung gestellt. Jedes Feld beinhaltet eine kurze Beschreibung (ausser den Feldern Name und Beschreibung, da diese eindeutig sind), um sicherzustellen, dass die richtigen Informationen am richtigen ort eingegeben werden und die Anwendung ordnungsgemäß registriert wird.
Alle Anwendungen werden in der Liste unter dem Abschnitt Webanwendungsregistrierung angezeigt
Bei der Markteinführung stehen ihnen mehrere Beispiele zur Verfügung, um zu verstehen wie man eine benutzerdefinierte Webanwendung schreibt und wie man den Authentifizierungsdialog erzeugt. Sie können diese und weitere Informationen hier in unserer BarTender Cloud Hilfe finden.