BarTender Cloud REST API – Legacy-Authentifizierung
Überblick
Frühere Versionen von BarTender Cloud nutzten OAuth 2.0 mit Open ID Connect (OIDC) für Webanwendungen, um Zugriff auf die BarTender Cloud Rest API zu erhalten. OAuth ist ein Authentifizierungsmechanismus, der es Diensten ermöglicht, Daten mit Drittanbieter-Webanwendungen zu teilen. Es dient als Alternative zur Weitergabe von Anmeldedaten und den damit verbundenen Sicherheitsrisiken. OIDC ist ein offenes Authentifizierungsprotokoll, das auf dem OAuth 2.0-Framework aufbaut.
Obwohl der erweiterte Identitätsanbieter von BarTender Cloud jetzt auch eine eigene Authentifizierung unterstützt, bietet dieser Artikel einen detaillierten Einblick, wie die ältere OAuth-Authentifizierung funktioniert. Da dies ein fortgeschrittenes Thema ist, richtet sich dieser Leitfaden an Personen mit technischem Hintergrund.
Gilt für
BarTender Cloud REST API
Informationen
Registrierungsprozess für Webanwendungen
Registrieren Sie Ihre Webanwendungen in BarTender Cloud, indem Sie zu Administration > API-Schlüssel > Anwendung für OAuth-Zugriff registrieren navigieren.
Geben Sie den Namen und die Beschreibung in die entsprechenden Felder ein. Die Anforderungen für alle weiteren Felder finden Sie unten:
- Login-URI: Autorisierungs-Endpunkt innerhalb Ihrer Webanwendung, zu dem der Benutzer weitergeleitet wird. Weitere Informationen zur Weiterleitung finden Sie hier.
- Callback-Liste: Eine Liste von URLs innerhalb Ihrer Webanwendung, an die BarTender Cloud nach der Authentifizierung seine Antwort sendet.
- Logout-URLs: Endpunkte innerhalb Ihrer Webanwendung, zu denen der Benutzer nach dem Ausloggen weitergeleitet wird.
- Zugelassene Ursprünge (CORS): Obwohl nicht empfohlen, ermöglicht die Cross-Origin-Authentifizierung das direkte Einbetten von Anmeldeformularen in eine Anwendung. Wenn ein eingebetteter Login erforderlich ist, muss die Anwendung für Cross-Origin Resource Sharing (CORS) eingerichtet werden. Weitere Informationen zu CORS finden Sie hier.
- Zugelassene Web-Ursprünge: URLs, von denen auseine Cross-Origin-Authentifizierung durchgeführt werden kann. Weitere Informationen zur Cross-Origin-Authentifizierung finden Sie hier.
Weitere Informationen zu den Registrierungsparametern finden Sie in der Hilfedokumentation unter Webanwendung > So registrieren Sie eine Webanwendung bei BarTender Cloud.
OAuth-Authentifizierungsprozess
Kurz gesagt, OAuth ist eine Möglichkeit, Drittanbieterdiensten Zugriff auf Ihre BarTender Cloud-Inhalte in Ihrem Namen zu gewähren, ohne Ihr Passwort an diesen Dienst weiterzugeben. Es ist der Authentifizierungsprozess, der für Webanwendungen verwendet wird, die auf die BarTender Cloud Rest API zugreifen.
Technische Details zu OAuth
BarTender Cloud verwendet den OAuth-Anbieter Auth0, um den Authentifizierungsprozess abzuwickeln. Drittanbieter-Webanwendungen müssen deren API nutzen, um sich bei BarTender Cloud zu authentifizieren.
BarTender Cloud verwendet den Authorization Code Flow von Auth0 für die Autorisierung von Webanwendungen und bietet außerdem den Resource Owner Password Flow für vertrauenswürdige Anwendungen an.
OAuth Authorization Code Flow
Nachfolgend finden Sie eine Schritt-für-Schritt-Erklärung des Ablaufs, wenn Sie versuchen, sich über eine Drittanbieter-Webanwendung (der Client) bei BarTender Cloud zu authentifizieren, um auf Ihren Mandantenbereich zuzugreifen:
-
Wählen Sie innerhalb der Anwendung Anmelden aus.
-
Das SDK von Auth0 leitet Sie zum Autorisierungsserver weiter. Die URLs hierfür sind:
-
BarTender Cloud Americas und APJ-Umgebungen: https://bartendercloud-production.us.auth0.com/authorize
- BarTender Cloud EMEA-Umgebung: https://bartendercloud-production.eu.auth0.com/authorize
-
-
Der Autorisierungsserver leitet zur Anmelde- und Autorisierungsabfrage weiter.
-
Authentifizieren Sie sich mit einer der konfigurierten Anmeldeoptionen. Es kann sein, dass Sie eine Einwilligungsabfrage sehen, in der die Berechtigungen aufgelistet sind, die der Anwendung gewährt werden.
- Der Autorisierungsserver leitet mit einem einmalig verwendbaren Autorisierungscode zurück zur Anwendung.
-
Der Autorisierungsserver überprüft den Autorisierungscode, die Anwendungs-/Client-ID und das Anwendungs-/Client-Geheimnis.
- BarTender Cloud Americas und APJ-Umgebungen: https://bartendercloud-production.us.auth0.com/oauth/token
- BarTender Cloud EMEA-Umgebung: https://bartendercloud-production.eu.auth0.com/oauth/token
- Anwendungs-/Client-ID zur Identifizierung Ihrer Anwendung – Wird bei der Registrierung der Anwendung in BarTender Cloud generiert
- Anwendungs-/Client-Geheimnis zum Nachweis des Besitzes der ClientID – Wird bei der Registrierung der Anwendung in BarTender Cloud generiert
-
Der Autorisierungsserver antwortet mit einem ID-Token und einem Zugriffstoken (und optional einem Refresh-Token).
-
Die Anwendung kann das Zugriffstoken verwenden, um die unter dem Audience-Parameter angegebene API aufzurufen und auf BarTender Cloud-Daten und -Funktionen innerhalb ihres Geltungsbereichs zuzugreifen.
- Audience gibt den spezifischen API-Endpunkt an, den Sie ansprechen möchten.
-
Die API antwortet mit den angeforderten Daten.
Auth0 API
Weitere Informationen zur Integration der Auth0 API in Ihre Anwendung finden Sie im Web App Quickstart Guide.
Weitere Ressourcen
Hilfedokumentation:
Support-Artikel:
Weitere externe Ressourcen (alle Rechte vorbehalten):