Datenquellen
Verbinden von Anwendungen über OAuth mit Peakboard
Hier erfährst du, wie du die OAuth Authentifizierung deiner Anwendungen mit Peakboard nutzen kannst.
1. Auf Seite der zuzufügenden Anwendung
- API-Verwaltung des anzubindenden Dienstes öffnen
- eventuell neues Projekt/Anwendung/ClientID anlegen
- dem angelegten Projekt die Callback URL (Redirect URL) “https://www.peakboard.com/oauth2-callback/” zufügen (Die hinterlegte Callback URL musst in jedem Zeichen mit der aus dem Peakboard Designer übereinstimmen)
2. Im Peakboard Designer die Anwendung hinzufügen
- neue Resource mit entsprechendem Datenformat anlegen (Das Format in welchem die anzusprechende Anwendung Daten zurückgibt, meistens json)
- als Autorisierung “OAuth” wählen
- Über den Button “Request New Token” das Autorisierungsfenster öffnen
Falls ein Preset verwendet wird, kann der Schritt 2.1 übersprungen und direkt mit dem Schritt 2.2 fortgefahren werden.
2.1 Kein Preset verwenden
- bei Preset “Custom” auswählen
-
als Grant Type den verwendeten Grant Type des anzubindenden Dienstes auswählen
- OAuth2 - Authorization Code Flow: Meist genutzter Grant Type bei OAuth2
- OAuth2 - Password Code Flow: Sollte aus Sicherheitsaspekten 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
-
je nach gewähltem Grant Type die Request URL, Authorization URL und Access Token URL beim Anbieter der Anwendung nachschauen und eintragen.
- Request URL (nur OAuth1, URL zum Anfragen des initialen Request Token)
- Authorization URL (OAuth1+OAuth2, URL des Autorisierungsservers)
- Access Token URL (OAuth1+OAuth2, URL zum Anfragen/Erneuern des Access Tokens)
2.2 Preset verwenden
- Preset auswählen (dabei werden der Grant Type, sowie Request URL, Authorization URL und Access Token URL automatisch ausgefüllt)
3. Nutzerspezifische Daten zur Anwendung eingeben
- Die im Schritt 1 erhaltene ClientID eintragen
- Das im Schritt 1 erhaltene ClientSecret eintragen
- bestimmt Anfragen benötigen bestimmte Scopes. Alle benötigten Scopes für die geplante Anfrage eintragen. Mehrere Scopes werden durch ein Leerzeichen getrennt.
- Fall benötigt den Access Type angeben. Dieser wird meistens nicht benötigt (außnahme Google Cloud Platform). Wird bei den Presets eventuell direkt mit ausgefüllt falls der entsprechende Dienst einen AccessType unterstütz, kann jedoch auch auf Wunsch entfernt werden.
4. Peakboard der Anwendung gegenüber Autorisieren
- Den “Request Token” Button drücken. Anschließend öffnet sich automatisch ein Browserfenster.
- Im neu geöffneten Browserfenster den Anmeldevorgang der Anwendung durchführen.
- Falls die Anmeldung erfolgreich war, schließt sich das Browserfenster und der “Request New Token” Button ist mit “Authorized - Update Token” beschriftet.
- Damit ist die Autorisierung abgeschlossen.
5. Allgemeine Infos zu weiteren Vorgehensmöglichkeiten
- Die URL der neuen Webresource wird nun mit der Autorisierung ausgeführt. Hier können nun Anfragen an die API gestellt werden. Die genaue Url muss dabei bei der entsprechenden Anwendung ermittelt werden. Aktuell sind nur Http-GET Anfragen möglich.
- Über den “Authorized - Update Token” Button kann die vorhandene Autorisierung angepasst werden.
- Über die API-Verwaltung der Anwendung kann die Autorisierung für Peakboard bei Wunsch wieder entfernt werden (Falls nicht von der Anwendung anders vorgegeben).
