Schueleraustausch.Net Programs-App

Wie binde ich die App in meine Webseite ein?

Für die Einbindung in Ihre Webseite folgen Sie einfach den drei untenstehenden Schritten:

1. Notwendige Accesstoken von Austauschkompass anfragen

Um die App einzubinden werden zwei Accesstoken benötigt. Diese bekommen sie von Austauschkompass:
1. den orderApiToken - ausgesetllt auf ihre Website (benötigt um Bestellungen zu platzieren)
2. den crmApiToken - ausgestellt auf ihre Website (benötigt um notwendige Daten zu beziehen)

2. Code kopieren

Kopieren Sie sich das folgende HTML-Snippet

<div id='sch-net-programs-app' data-ak-config='{ "orderApiToken": "IHR_ORDER_API_TOKEN", "crmApiToken":"IHR_CRM_API_TOKEN" }'></div>
<script src='https://assets.austauschkompass.de/react_app_loader/index.js'></script>
<script type='text/javascript'>
  document.addEventListener('DOMContentLoaded', function() {
    akLoader.init('https://assets.austauschkompass.de/sch_net_programs_app/2/build')
  })
</script>

und fügen Sie es bitte zur weiteren Bearbeitung in einen Texteditor (auf Windows z.B. Notepad bzw. Editor) ein.

Wichtig: Die Bearbeitung des Snippets darf ausschließlich als Reintext erfolgen. Daher sind Textverarbeitungsprogramme wie Word bzw. Wordpad hierfür ungeeignet!

3. gewünschte Optionen anpassen

Die Einstellungen der App werden in einer einzigen Zeile (keine Umbrüche) im HTML-Attribut data-ak-config='{ "orderApiToken":"IHR_ORDER_API_TOKEN", ...
eingetragen.

Die folgenden Optionen müssen in jedem Fall erhalten bleiben, können aber vom Inhalt her angepasst werden.

Notwendige Optionen

Name	Typ	Beschreibung
orderApiToken	string	ein auf ihre Website ausgestellter Accesstoken - z.B. IHR_ORDER_API_TOKEN
crmApiToken	string	ein auf ihre Website ausgestellter Accesstoken - z.B. IHR_CRM_API_TOKEN

Weitere Optionen zur Eingrenzung der angezeigten Austauschprogramme

Mit Verwendung der folgenden Filter-Optionen kann die Auswahl der gelisteten Programme vorgefiltert werden.

Name	Typ	Standard (Default)	Beschreibung
filter_countryCode	string	"GB"	ISO 3166 Alpha-2 Country-Code, Großbuchstaben; wenn gesetzt werden nur Programme für dieses Land gelistet.

3. Code in Zielwebseite als HTML einfügen

Der angepasste Code muss aus dem Texteditor ohne weitere Veränderungen direkt als HTML in der Zielwebseite gespeichert werden. Das erfolgt je
nach Art der Pflege der Webseite unterschiedlich.

Im Falle von WordPress und dem Gutenberg-Editor, muss hierfür auf einer Seite ein neuer Block (Typ HTML) angelegt und der Code dort eingefügt werden.

Sollten Sie Änderungen an den Optionen einer bereits eingebundenen Schueleraustausch.Net Programs-App vornehmen wollen, wiederholen Sie dafür einfach die
hier aufgeführten Schritte mit den angepassten Optionen und ersetzen Sie den bisherigen Code-Block in Ihrer Webseite mit dem angepassten
Code.