Versions Compared

Version Old Version 2 New Version 3
Changes made by

Frederike Knuth (Unlicensed)

Frederike Knuth (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Bestandteil des https://digitale-verwaltung.atlassian.net/servicedesk/customer/portal/3/article/344166950

  •  Antragsstrecken als Web Component auf Ihrer gewünschten Webseite einbinden.
Panel
panelIconIdatlassian-info
panelIcon:info:
panelIconText:info:
bgColor#FFBDAD

Hinweis: Sie können erst mit der Einbindung der Antragsstrecken beginnen, wenn Sie die Information von uns erhalten haben, dass die Mandanten für Ihre Kommune bzw. Ausländerbehörde eingerichtet wurden.

⚠️ Wenn Sie die Antragsstrecken des Online-Dienstes einzeln auf Ihrer Webseite einbinden möchten, muss jede Antragsstrecke einzeln via Web Component eingebunden werden.

Die Verwendung der „Bündelungskomponente“ vereinfacht die Implementierung der Antragsstrecken via Web Component. Weitere Informationen können Sie dem Kapitel 4.6 Einbindung Bündelungskomponente entnehmen.

Die Einbindung der Antragsstrecken via Web Component wird über das Hinzufügen weniger Codezeilen in dem HTML-Code Ihrer Webseite durchgeführt. Eine generalisierte Anleitung für die technische Integration finden Sie unter Anleitung | Digitale Verwaltung as a Service. Bitte beachten Sie, dass bei der Einbindung

  • der “ags-wert” - hierbei handelt es sich um den Amtlichen Gemeindeschlüssel Ihrer Gebietskörperschaft. Es müssen alle 8 Ziffern angegeben werden.

  • der “dienst-wert”

für Ihre Kommune bzw. Ausländerbehörde individuell angepasst werden muss. Nähere Informationen finden Sie unter Anleitung | Digitale Verwaltung as a Service .

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#FFBDAD

Wichtig: Ihre Web Component Einbindung muss über die Domain, oder deren Unterseiten, eigebunden werden, die von Ihnen im Self-Service-Ticket unter der Angabe “Domain” angegeben wurde.

Zudem muss die Web Component auf einem “echten” Webserver mit einer eigenen Domain eingerichtet sein. Der Abgleich der Domain bei Aufruf der Web Component mit den am Mandanten hinterlegten Domain-Informationen ist Teil des Sicherheitskonzepte des Online-Dienstes. Die Einbettung mit „localhost“ ist leider nicht umzusetzen.

Nachfolgend finden Sie eine Vorlage für einen vollumfänglich konfigurierten HTML-Code sowie eine Detaillierung der Anpassungsoptionen am Beispiel der dezentralen Antragsstrecke “Aufenthaltstitel zur Erwerbstätigkeit“:

Vollumfängliche Beispielkonfiguration Web Component “Aufenthaltstitel zur Erwerbstätigkeit”

Wir empfehlen die Web Component Einbindung durch die Ansprechpersonen vornehmen zu lassen, die bei Ihnen im Haus für die Pflege der Webseite zuständig sind.

Kategorien zur Anpassung des Codes

Farbe

Bedeutung

Rot

Code muss für die korrekte Funktionsweise der Web Component 1:1 übernommen werden.

Gelb

Code muss aus fachlichen Gründen übernommen werden, kann aber textuell (nicht die HTML-Attribute) angepasst werden.

Grün

Code ist optional und die Einbindung der Web Component. Es wird jedoch auf Grund von Nutzerfreundlichkeit und einer einheitlichen Darstellung der Web Component empfohlen diesen zu verwenden.

Türkis

Code muss dienstspezifisch angepasst werden.

Grau

Code muss mandantenspezifisch angepasst werden.

Violett

Attribute, welche zusätzliche Funktionen für die Antragsstrecke bereitstellen. Diese können bei Bedarf hinzugefügt werden, um z.B. das Nutzerkonto anzubieten.

HTML-Code Beispiel Aufenthaltstitel zur Erwerbstätigkeit mit Attributen

<html lang="de">       

        <head>

            <meta charset="UTF-8">

            <meta name="viewport" content="width=device-width, initial-scale=1.0">

            <title>Antrag für einen Aufenthaltstitel zur Erwerbstätigkeit</title>

            <link rel="stylesheet" href="https://api.service-digitale-verwaltung.de/embed/themes/tf-blue.css">

            <script src="https://api.service-digitale-verwaltung.de/embed/polyfill/polyfill.js"></script>

        </head>

        <body style="margin-top: 4rem;">

            <noscript>

                Für die Verwendung dieses Dienstes ist JavaScript erforderlich.

                Bitte aktivieren Sie diese Funktion in Ihren Browsereinstellungen oder verwenden Sie einen anderen Web-Browser mit aktiviertem JavaScript.

            </noscript>

                <at-erwerbstaetigkeit ags="12345678" language-selection hide-login="false" plz-check hide-page-nav="false" page-nav-position="left" ></at-erwerbstaetigkeit>               

                <script src="https://api.service-digitale-verwaltung.de/embed/at-erwerbstaetigkeit/at-erwerbstaetigkeit.js" charset="UTF-8"></script>

                                  

        </body>

    </html>