Skip to content
Snippets Groups Projects
Commit 1b50b2e1 authored by Andreas Huber's avatar Andreas Huber
Browse files

Erster Teil der OAuth-Doku

parent 4db90774
1 merge request!9Version 0.5
assets/images/oauth/01_portal.png

254 KiB

# Authentifizierung und Autorisierung
...
## Anwender Registrierung
**Noch in Arbeit**
Das FIT-Connect API Portal ist unter der folgenden URL erreichbar:
https://portal.fiep-poc.de
Eine Behörde, die ein Verfahren anbieten möchte, registriert sich zunächst am Portal mit dem Button "Registrieren". Diese Funktion steht auch rechts oben unter "Mein Konto" zur Verfügung.
![API-Portal](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/01_portal.png)
![Registrierung](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/02_register.png)
![Registrierung abgesendet](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/03_registered.png)
Im Anschluss erhalten Sie zwei verschiedene E-Mails.
Die zweite E-Mail kommt mit einer zeitlichen Verzögerung von bis zu 30 Minuten.
In der ersten Email wird ihre Registrierungsanfrage bestätigt:
> Hallo Werner Mustermann,
>
> ihre Anfrage zur Registrierung ist aufgenommen worden. Sie erhalten noch zwei weitere Bestätigungsmails.
>
> Mit besten Grüßen,
> Ihr FIT-Connect API Portal Team
>
> *** Diese Benachrichtigung wurde automatisch erstellt. Antworten Sie nicht auf diese Email.***
In der zweiten Email wird ihnen noch die Anwender-ID mitgeteilt.
Diese Anwender-ID ist essenziell für die weitere Arbeit mit den APIs.
Sie ist Bestandteil sowohl der Aufruf URLs als auch Bestandteil der Scopes für die OAuth 2.0. Authorization / Authentication.
**Erst nach Erhalt der Email können sie sich anmelden!**
Hier ein Beispiel einer solchen Email:
> Sehr geehrter Herr Mustermann,
>
> wir freuen uns über ihre Teilnahme an dem POC Fit-Connect.
>
> Ihre Anwender-ID lautet: c94ae37e-dcc5-345e-a530-8651bdfa5f2c
>
> Mit freundlichem Gruß
> Ihr FIT-Connect Team.
## Client (Anwendung) Registrierung auf ein API
<!-- theme: warning -->
> **Hinweis:** Im Zuge der ersten Anmeldung empfehlen wir die Umstellung der Sprache auf Deutsch.
![Einstellungen aufrufen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/04_settings.png)
![Sprache auswählen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/05_language.png)
Im zweiten Schritt wird die von ihrer Behörde angebotene Anwendung (auch Client genannt) registriert.
Dies erfolgt durch Aufruf der Details des für die Anwendung gewünschten API
Dazu klicken sie in der Titelleiste auf "APIs":
![APIs aufrufen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/06_apis.png)
In der nun angezeigten Liste klicken Sie beim API "SubscriberAPI" auf den Button "Details anzeigen >>"
![API Details aufrufen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/07_select_api.png)
In der Detailanzeige klicken sie rechts oben unter "Was als Nächstes?" auf "Client anmelden und Zugriffs-Token auswählen".
![Client anmelden](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/08_register_client.png)
Nun erscheint der folgende Dialog:
![Token anfordern](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/09_request_token.png)
Hier vergeben Sie einen Anwendungsnamen und eine Beschreibung. Die Angabe einer Umleitungs-URI ist optional.
Mit dem Button "Token anfordern" lösen Sie die Erstellung der Anwendung (Client) und der für Sie gültigen Subscriber-ID (subscriber-id) und/oder Source/Sender-ID (source-id) aus. Diese Subscriber-ID wird für alle weiteren API Aufrufe benötigt.
Im Hintergrund wird nun automatisch eine nur für ihre Behörde und diese Anwendung gültige Scope Konfiguration erstellt. Dies Konfiguration kann über den Menüpunkt "Applications" eingesehen werden.
![Anwendungen aufrufen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/10_goto_applications.png)
![Anwendungen](https://raw.githubusercontent.com/fiep-poc/assets/master/images/oauth/11_applications.png)
Aus dieser Liste heraus können sie die Details der Anwendung durch Klick auf den Namen der Anwendung ansehen.
... TO BE CONTINUED ...
...
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment