Navigation und Service

Hinweise und Empfehlungen für die Struktur Ihres Web-Dienstes

Nehmen Sie Nutzer:innen auf Ihrer Webseite an die Hand, damit diese den Ausweisvorgang erfolgreich abschließen können. Wir empfehlen Ihnen hierbei, den Ausweisprozess in mehrere, aufeinander aufbauende Dialoge aufzuteilen. So finden sich Ihre Nutzer:innen schnell zurecht. Als Beispiel kann der Dienst „Open PGP-Schlüssel beglaubigen“ dienen. Dieser steht unter https://pgp.governikus.de/pgp zur Verfügung.

Wir empfehlen Ihnen, Ihren Dienst in die nachfolgenden Schritte zu untergliedern:

  1. Landingpage mit Begrüßung
  2. Voraussetzungen zur Nutzung der Online-Ausweisfunktion
  3. Hinweise zum Ablauf des Ausweisvorgangs
  4. Rückmeldung zum Ergebnis des Auslesevorgangs

Schritt 1: Landingpage

Stellen Sie direkt beim ersten Kontakt Ihrer Nutzer:innen einen Bezug zum Online-Ausweis her und teilen Sie von Beginn an mit, dass der Online-Ausweis zur Erledigung einer Aufgabe eingesetzt werden kann.

Zusätzlich zu textuellen Hinweisen empfehlen wir die Verwendung des Logos des Online-Ausweises. Dieses Logo findet sich auf den haptischen Ausweisdokumenten, im PIN-Brief und auch in der AusweisApp2. So schaffen Sie eine optische Wiedererkennung. Platzieren Sie das Logo am besten direkt auf der Schaltfläche oder dem Button, die bzw. der den Dialog zum eigentlichen Ausweisvorgang startet.

Logos und Textbausteine stehen Ihnen hier zum Download bereit.

Bei mehreren Authentifizierungsmöglichkeiten empfehlen wir, diese gleichberechtigt neben- oder untereinander zu platzieren.

Als Behörde sollten Sie an dieser Stelle auf das Servicekonto eines Bundeslandes oder des Bundes verlinken und Ihre Nutzer:innen darauf hinweisen, dass sich hinter dem Link ggf. mehrere Angebote befinden.

Verweisen Sie für weiterführende Informationen zum Online-Ausweis und zur Nutzung der AusweisApp2 gerne auf das AusweisApp2-Portal oder das Personalausweisportal.

Schritt 2: Voraussetzungen

Erklären Sie Ihren Nutzer:innen, was sie für das Online-Ausweisen benötigen. Folgende drei Voraussetzungen müssen erfüllt sein:

  1. Besitz eines Personalausweises oder elektronischen Aufenthaltstitels mit aktivierter Online-Ausweisfunktion oder einer eID-Karte für Unionsbürger:innen
  2. Ein NFC-fähiges Smartphone (aktuell mit mind. Android 5.0 oder iOS 13.1) oder ein USB-Kartenleser müssen parat liegen
  3. Die AusweisApp2 muss installiert sein

Schritt 3: Hinweise zum Ablauf

Geben Sie Ihren Nutzer:innen an dieser Stelle wichtige Hinweise zur Durchführung des Ausweisvorgangs.

Auf Desktop-Systemen ist es an dieser Stelle entscheidend, Nutzer:innen darauf hinzuweisen, die AusweisApp2 zu starten. Dies ist notwendig, damit die App in den Vordergrund kommen und der Auslesevorgang gestartet werden kann. Geben Sie auch hier ruhig noch einmal den Hinweis, wo und wie die AusweisApp2 heruntergeladen werden kann.

Sie haben auf Desktop-Systemen auch die Möglichkeit, über den Aufruf http://127.0.0.1:24727/eID-Client?Status zu prüfen, ob die AusweisApp2 bereits gestartet ist. Im positiven Fall kann der o.g. Hinweis automatisch übersprungen werden.

Auf mobilen Systemen ist ein Hinweis zum Starten der AusweisApp2 nicht notwendig, da die App dort automatisch gestartet wird.

Unterstützung bei der Prüfung der Verfügbarkeit der AusweisApp2

Bei der Prüfung der Verfügbarkeit der AusweisApp2 kann Sie die Bibliothek @ausweisapp2/identglue unterstützen, deren Dokumentation und Quellcode auf GitHub veröffentlicht ist. Diese übernimmt die Statusprüfung auf Desktop-Systemen. 

Auf mobilen Systemen unterstützt die Bibliothek außerdem eine Prüfung, ob der Aufruf Ihres Dienstes erfolgreich war. Damit erkennen Sie eine fehlende Installation der AusweisApp2 und können der Benutzer:in entsprechende Hinweise anbieten. Weitere Details entnehmen Sie bitte der mitgelieferten Dokumentation bzw. dem Beispiel.

Plattformspezifische Hinweise zur Installation der AusweisApp2

Damit Nutzer:innen Ihren Dienst mit einem Mobilgerät vollumfänglich nutzen können, muss die AusweisApp2 vorher installiert werden. Verweisen Sie hierfür auf die plattformspezifische Installation der AusweisApp2.

Bitte beachten Sie hierbei auch die Marketing-Richtlinien der Anbieter:

Schritt 4: Rückmeldung

Geben Sie Ihren Nutzer:innen eine Rückmeldung zum Ergebnis des Ausweisvorgangs. Teilen Sie also nach dem Auslesevorgang mit, ob dieser erfolgreich war oder nicht.

Im Falle eines Fehlers, werten Sie die von der AusweisApp2 bzw. dem eID-Server an Ihre Webanwendung übergebene Fehlermeldung aus und zeigen Sie einen entsprechenden Fehlertext an. Das Ziel ist hier natürlich, die Nutzer:innen bei der Behebung des Problems zu unterstützen und zu einem erfolgreichen zweiten Auslesevorgang zu führen.