02.02.2024

Webling-Schnittstelle einrichten

Webling und Helfereinsatz können über eine Schnittstelle verbunden werden. So könnt ihr alle eure Mitglieder automatisiert als Helfende importieren und aktuell halten.

Wichtige Vorbemerkung: Wir empfehlen, die Schnittstelle dann einzurichten, wenn im Tool grade nicht viel los ist. Wird die Schnittstelle falsch konfiguriert, kann das zu fehlerhaften Datensätzen führen. Deshalb nehmt euch die Zeit, das in Ruhe durchzuackern.

API-Key erstellen

Um die Schnittstelle zu Webling verwenden zu können, muss als erstes ein sogenannter API-Key generiert werden. Den könnt ihr in Webling unter "Administration" - "Aboverwaltung" - "API" - "Neuer Apikey" automatisch generieren lassen.

Im ersten Schritt gebt ihr dem Key eine Beschreibung. Hier empfehlen wir, den Key so zu benennen, wie er benutzt wird. Also beispielsweise "Helfereinsatz".
Anschliessend könnt ihr dem Key Rechte zuweisen. Hier reicht der Zugriff auf die Mitglieder. Wenn Helfereinsatz nur Daten von Webling empfangen soll, setzt ihr die Auswahl bei "Alle Mitglieder lesen". Wenn die beiden Tools informationen austauschen sollen, entsprechend bei "Alle Mitglieder lesen und schreiben".

1. Schnittstelle einrichten

Um die Schnittstelle in Helfereinsatz einzurichten, navigiert ihr unter "Organisation" - "Externe APIs" auf "Webling" - "Jetzt einrichten".
Als erstes wird hier nun der Modus gewählt. Hier könnt ihr aus zwei Optionen auswählen:

Nur lesen

In diesem Modus hat Helfereinsatz NUR Leserechte der Daten von Webling. Daraus folgt, dass Helfende, die aus Webling importiert werden, in Helfereinsatz NICHT bearbeitet werden können. Die Mitgliederbearbeitung erfolgt einzig über Webling.

Neue Helfende können sich weiterhin registrieren, sie werden allerdings nicht automatisch in Webling erfasst. Dies muss manuell geschehen. Helfende, die nicht mit Webling verknüpft sind, sind unter "Helfende" - "Helfende, die nicht mit Webling verknüpft sind" ersichtlich.

Wird eine Person in Webling gelöscht, bedeutet das KEINE automatische Löschung in Helfereinsatz. Es könnte ja sein, dass diese Person noch Einsätze gebucht hat. Es wird nur die Verlinkung zu Webling gelöscht.

Lesen und Schreiben

In diesem Modus werden Anpassungen von Helfendendaten SOFORT auf Webling geschrieben. Wird also eine Telefonnummer geändert, wird diese sofort auch in Webling angepasst.
 

Bei beiden Modi gilt zu beachten, dass die Übertragung von Weblingdaten auf Helfereinsatz jeweils Nachts einmalig geschieht, während Helfereinsatz bei Lese- und Schreibberechtigung immer sofort Daten übermittelt.

Wichtig: Wenn Helfereinsatz Schreib- und Leserechte hat, wird mit jeder/-m neuen Helfenden ein neuer Datensatz in Webling erstellt. Entsprechend muss auch sichergestellt werden, dass das Webling-Abo ausreichend gross gewählt ist. Wenn das Limit in Webling erreicht wird, kann Helfereinsatz keine neuen Datensätze mehr erstellen. Dies führt in der Folge zu Fehlern bei der Registrierung von neuen Helfenden.

2. Helfer-Feld-Zuweisung

Im zweiten Schritt der Einrichtung müssen die Felder zwischen Webling und Helfereinsatz zugewiesen werden. Helfereinsatz zeigt euch an die Pflichtfelder an, und ihr sucht euch im Dropdown das zugehörige Feld in Webling aus. Auch optionale Felder können direkt zugewiesen werden.

WICHTIG: Achtet beim Telefon darauf, dass Webling einen Unterschied zwischen Telefon und Mobile kennt. Im Einsatzkontext ist es sinnvoll, das Helfereinsatz-Telefon mit dem Webling-Mobile (statt dem Webling-Telefon) zu verknüpfen.

3. Gruppenzuweisung

In Helfereinsatz und in Webling können Mitglieder in Gruppen organisiert werden. Damit die Gruppen korrekt übertragen werden, werden sie im dritten Schritt zugeordnet.

Webling Import-Gruppen

Ihr müsst nicht alle Mitglieder von Webling in Helfereinsatz importieren. Wollt ihr alle Weblingmitglieder importieren, wählt ihr bei der Weblinggruppe einfach "Mitglieder". Ihr könnt aber auch nur die Gruppen bestimmen, welche importiert werden sollen. Wichtig: wenn ihr eine Webling Gruppe bestimmt, werden automatisch auch alle Webling-Untergruppen importiert.

Gruppe für neue Helfer

Wenn ihr die Schnittstelle mit Lese- und Schreiberecht verwendet, müsst ihr angeben, in welcher Weblinggruppe neue Helfende erfasst werden sollen, wenn bei der Neueröffnung in Helfereinsatz KEINE Gruppe angegeben wurde. Im Lesemodus müsst ihr hier nichts angeben.

Gruppen Zuweisungen

Als drittes bestimmt ihr bei jeder Helfereinsatzgruppe, welche Gruppe in Webling damit übereinstimmt.

4. Abschluss und Aktivierung

Nach der Konfiguration muss die Schnittstelle noch aktiviert werden. Sobald die Schnittstelle aktiv ist, werden täglich um 03:00 Uhr die Daten aus Webling importiert. Ein Import kann jederzeit auch manuell gestartet werden.

Anleitung als Video

Im folgenden Youtube-Video wird euch alles, was wir auf dieser Seite erklärt haben, auch einfach gezeigt: