Datenquellen
Verbinden von Anwendungen über OAuth mit Peakboard
Hier erfährst du, wie du die OAuth-Authentifizierung deiner Anwendungen mit Peakboard nutzen kannst. OAuth wird von vielen Web-APIs (z.B. Spotify, Slack, Google) verwendet, um den Zugriff auf geschützte Daten zu autorisieren, ohne Benutzername und Passwort direkt zu hinterlegen.
1. Auf Seite der anzubindenden Anwendung
- API-Verwaltung des anzubindenden Dienstes öffnen
- eventuell ein neues Projekt/eine neue Anwendung/eine ClientID anlegen
- dem angelegten Projekt die Callback URL (Redirect URL)
https://www.peakboard.com/oauth2-callback/zufügen (die hinterlegte Callback URL muss in jedem Zeichen mit der aus dem Peakboard Designer übereinstimmen)
2. Datenquelle im Peakboard Designer anlegen
Lege eine neue Datenquelle mit dem Datenformat an, in dem die anzusprechende Anwendung Daten zurückgibt – meistens JSON. Öffne dazu [Datenquelle hinzufügen] und wähle die passende Datenquelle (hier: [JSON]) aus.
3. OAuth als Authentifizierung auswählen
Öffne im Konfigurationsdialog der Datenquelle das Auswahlfeld [Authentication Type] und wähle den Eintrag [OAuth].
Sobald [OAuth] ausgewählt ist (1), erscheint daneben der Button [Request new token] (2). Über diesen Button öffnest du das Fenster zur OAuth-Konfiguration.
4. OAuth ohne Preset konfigurieren
Wenn du kein Preset verwendest, konfigurierst du die Verbindung manuell im Fenster [OAuth configuration].
- Bei [Presets] (1) den Eintrag [Custom] auswählen.
-
Bei [Grant type] (2) den vom anzubindenden Dienst verwendeten Grant Type wählen:
- OAuth2 - Authorization Code Flow: der am häufigsten genutzte Grant Type bei OAuth2
- OAuth2 - Password Grant: sollte aus Sicherheitsgründen nur verwendet werden, falls die anzubindende Anwendung keine Alternative bietet
- OAuth1: wird für Anwendungen genutzt, die nur OAuth1 und noch kein OAuth2 unterstützen
- Die [Callback URL] (3) ist bereits vorausgefüllt und muss exakt der in Schritt 1 hinterlegten Redirect URL entsprechen.
-
Je nach gewähltem Grant Type die [Access token URL] (4) und [Authorisation URL] (5) beim Anbieter der Anwendung nachschauen und eintragen:
- Access token URL (OAuth1+OAuth2, URL zum Anfragen/Erneuern des Access Tokens)
- Authorisation URL (OAuth1+OAuth2, URL des Autorisierungsservers)
- Die in Schritt 1 erhaltene [Client ID] (6) und das [Client secret] (7) eintragen.
- Falls die geplante Anfrage bestimmte Scopes benötigt, alle benötigten Scopes im Feld [Scope] eintragen. Mehrere Scopes werden durch ein Leerzeichen getrennt.
- Falls benötigt, den [Access type] angeben. Dieser wird meistens nicht benötigt (Ausnahme: Google Cloud Platform).
5. OAuth mit Preset konfigurieren
Für viele bekannte Dienste steht ein Preset zur Verfügung. Öffne dazu das Auswahlfeld [Presets] und wähle den passenden Dienst.
Nach der Auswahl eines Presets (1) werden Grant Type, [Access token URL] (2) und [Authorisation URL] (3) automatisch ausgefüllt. Du musst nur noch die [Client ID] und das [Client secret] des Dienstes ergänzen.
6. Peakboard gegenüber der Anwendung autorisieren
- Den Button [Request token] (8) drücken. Anschließend öffnet sich automatisch ein Browserfenster.
- Im neu geöffneten Browserfenster den Anmeldevorgang der Anwendung durchführen.
- War die Anmeldung erfolgreich, schließt sich das Browserfenster und der Button [Request new token] ist nun mit [Authorized - Update Token] beschriftet.
- Damit ist die Autorisierung abgeschlossen.
7. Allgemeine Infos zu weiteren Vorgehensmöglichkeiten
- Die URL der neuen Datenquelle wird nun mit der Autorisierung ausgeführt. Hier können Anfragen an die API gestellt werden. Die genaue URL muss bei der entsprechenden Anwendung ermittelt werden. Aktuell sind nur HTTP-GET-Anfragen möglich.
- Über den Button [Authorized - Update Token] kann die vorhandene Autorisierung angepasst werden.
- Über die API-Verwaltung der Anwendung kann die Autorisierung für Peakboard bei Bedarf wieder entfernt werden (falls nicht von der Anwendung anders vorgegeben).
