Vorbereiten

Damit Sie die Applets auf Ihrer Webseite nutzen können, fügen Sie bitte das Hilfe-Programms als <script> - Tag im Header Ihrer Webseite hinzu:

<script src="https://integration.fahrschule-api.de/js/integrationHandler.js"/>

Generator

In der Administrationsoberfläche finden Sie einen Generator zur Erstellung der unteren Elemente und mit Ansicht einer Vorschau. Sie müssen im Anschluss diese nur noch in Ihr HTML integrieren.

https://admin.fahrschule-api.de/more/integration

Applets

Applets bieten Ihnen die Möglichkeit, verschiedene Oberflächen schnell und einfach in Ihre Webseite zu integrieren. Dies kann zum Beispiel die Übersicht der aktuellen Unterrichtsstunden, der Filialen oder auch ein Formular sein.

Einbindung

Stellen Sie zunächst sicher, dass Sie den Abschnitt Vorbereitungen abgeschlossen haben. Im Anschluss können Sie Elemente zu Ihrer Webseite hinzufügen, indem Sie den nachfolgenden HTML in Ihrer Webseite übernehmen.

<fa-element client_id="fahrschule_default" type="education_calendar"/>

Fehlerbehandlung

falsche Konfiguration
Bei der Einbindung können Fehler durch eine falsche Konfiguration des Einbindungselements auftreten. Anbei finden Sie die häufigsten Fehlerquellen.

ERR_MISSING_CLIENT_ID Bitte überprüfen Sie, ob das Applet den Parameter client_id enthält. Falls dieser Fehler weiterhin auftritt benachrichtigen Sie uns bitte.

ERR_TYPE_NOT_FOUND Bitte überprüfen Sie den in der URL mitgegebenen Parameter ob dieser existiert und richtig geschrieben ist. Ansonsten kann das im Hintergrund befindliche Modul nicht gefunden werden und es ist nicht klar, welche Oberfläche angezeigt werden soll.

Element wird nicht angezeigt
In einigen Fällen kann es passieren, dass das Element nicht erkannt oder angezeigt wird. Das ist insbesondere dann der Fall, wenn Sie zum Beispiel ein CMS oder ein Framework für Ihre Webseite nutzen oder JavaScript nicht verfügbar ist. Im ersten Fall können Sie die globale Methode FA_Handler.refresh(); aufrufen, um auch nachträglich eingebundene Elemente erkennen zu können. Sprechen Sie uns hierzu gerne persönlich an.

ChatBot

Neben dem ChatBot als Applet können Sie diesen auch als Messenger einbinden. Dieser erscheint dann als klickbarer Button auf der rechten unteren Seite.

Einbindung

Stellen Sie zunächst sicher, dass Sie den Abschnitt Vorbereitungen abgeschlossen haben. Im Anschluss können Sie Elemente zu Ihrer Webseite hinzufügen, indem Sie den nachfolgenden HTML in Ihrer Webseite übernehmen.

<fa-messenger client_id="fahrschule_default"/>

Fehlerbehandlung

falsche Konfiguration
Sollten Sie eine falsche ClientID angegeben haben wird der ChatBot nach der ersten Nachricht Sie darauf hinweisen.

Datenelemente

Für einzelne Informationen aus der API können Sie diese direkt kontaktieren oder die bereitgestellten Datenelemente nutzen. Sollten die angeforderten Daten nicht vorhanden sein, werden hier auch keine Daten ausgegeben.

Einbindung

Stellen Sie zunächst sicher, dass Sie den Abschnitt Vorbereitungen abgeschlossen haben. Im Anschluss können Sie Elemente zu Ihrer Webseite hinzufügen, indem Sie den nachfolgenden HTML in Ihrer Webseite übernehmen und ggf. anpassen.

<fa-data client_id="fahrschule_default" path="company/branch" source="1.name"/>

Die 3 Parameter werden verwendet um den anzuzeigenden Text zu ermitteln.

client_id: id der Fahrschule
path: URL-Pfad des Endpunktes
source: Auswahl der Parameter

Eine genaue Dokumentation der Endpunkte ist unter der folgenden Domain zu finden:

https://fahrschule-api.de/api-docs/

Fehlerbehandlung

falsche Konfiguration
Sollten Sie eine falsche ClientID angegeben haben wird der ChatBot nach der ersten Nachricht Sie darauf hinweisen.

keine Anzeige
Wenn Ihnen kein Wert angezeigt wird, ist der Endpunkt entweder nicht vorhanden oder die angesprochenen Daten (source) aus der Antwort des Servers nicht verfügbar. Bitte schauen Sie sich hierzu die Logs der Konsole an und passen Sie die Parameter an.