OAuth 2.0 mit der eID Authentifizierung API einrichten
Diese Anleitung beschreibt Schritt für Schritt, wie Sie die eID Authentifizierung API in Ihre Anwendung integrieren.
Einleitung in den Authentifizierungsfluss
Die eID Authentifizierung ermöglicht es Dienstanbietern, die Identität von Nutzern sicher und digital zu verifizieren. In diesem Tutorial konzentrieren wir uns auf den OAuth 2.0 Authorization Code Flow, der den Standard für Web-Anwendungen darstellt.
Voraussetzungen
- Registriertes Entwickler-Konto im Bundes-API-Portal
- Gültiger API-Client (Client ID und Secret)
- Erlaubnis zur Nutzung des Identitätsdienstes
curl -X POST https://api.bund.de/eid/v1/authKonfiguration des Clients
Bevor Sie Anfragen senden können, müssen Sie Ihren Redirect-URI im Dashboard hinterlegen. Dieser muss zwingend mit HTTPS verschlüsselt sein.
Die Sicherheit der Nutzerdaten hat oberste Priorität. Verwenden Sie für die Kommunikation ausschließlich TLS 1.3 oder höher. Alle anderen Versionen werden vom API-Gateway abgelehnt.
Schritt-für-Schritt Integration
- Initialisieren Sie die OAuth-Anfrage an den /authorize Endpunkt.
- Der Nutzer wird auf die offizielle Anmeldeseite des Bundes weitergeleitet.
- Nach erfolgreicher Authentifizierung erhält Ihre Anwendung einen Authorization Code.
- Tauschen Sie den Code gegen einen Access Token am /token Endpunkt ein.
HTTP Status Codes
| Code | Bedeutung | Beschreibung |
|---|---|---|
| 200 | OK | Die Anfrage war erfolgreich und die Daten werden zurückgegeben. |
| 400 | Bad Request | Die Anfrage ist fehlerhaft formatiert oder Parameter fehlen. |
| 401 | Unauthorized | Der API-Key ist ungültig oder abgelaufen. |
| 500 | Server Error | Ein interner Fehler ist im API-Gateway aufgetreten. |
Hinweis
,Bitte beachten Sie, dass Test-Umgebungen (Sandbox) keine Echtdaten von Personalausweisen verarbeiten können. Nutzen Sie für Tests unsere bereitgestellten Test-Identitäten.,