02.02.2020

Webling Schnittstelle einrichten

Mit der API zu Webling könnt ihr alle Vereinsmitglieder automatisch als Helfer erfassen.

Wichtige Vorbemerkung: Wir empfehlen die Schnittstelle in einer "ruhigen" Zeit im Jahr einzurichten. Richtet die Schnittstelle nicht während einer hektischen Zeit ein oder unmittelbar vor grossen und wichtigen Events. Wird die Schnittstelle falsch konfiguriert, kann es sein, dass Daten falsch geschrieben werden. Wenn ihr die Schnittstelle zu einem ruhigen Zeitpunkt einrichtet, kann das von Vorteil sein!

Um die Schnittstelle zu Webling verwenden zu können, muss als erstes ein sogenannter API-Key generiert werden. Dieser API-Key muss in Webling unter Administration API erstellt werden. Der API-Key braucht keine Administratoren Rechte! Wir brauchen lediglich Zugriff auf die Mitglieder. Wenn ihr aus Helfereinsatz auch die Änderung eurer Webling Daten ermöglichen wollt, braucht der API-Key die Berechtigung "Alle Mitglieder lesen und schreiben".

1. Schnittstelle einrichten

In Helfereinsatz kann die Schnittstelle unter Organisation --> Externe APIs eingerichtet werden. Es gibt zwei verschiedene Modi. Mehr zu den Modus Unterschieden gleich nachfolgend. Ebenfalls wird die Webling Subdomain gebraucht. Diese hat die Form "https://deinverein.webling.ch". Natürlich brauchst du auch noch den API Key, den du bei Webling generiert hast.

Modus: nur lesen

In diesem Modus erlaubt ihr Helfereinsatz NUR das Lesen der Daten von Webling. Die Konsequenz ist, dass jeder Helfer, der aus Webling importiert wird, in Helfereinsatz NICHT verändert werden kann. Eine Veränderung der Helferdaten in Helfereinsatz würde wenig Sinn machen, weil die Änderungen beim nächsten Import wieder überschrieben würden. In diesem Modus ist es Möglich, neue Helfer zu erfassen. Diese werden aber nicht automatisch in Webling erfasst.

Wird ein Helfer in Webling gelöscht, wird der Helfer in Helfereinsatz NICHT gelöscht. Es könnte ja sein, dass dieser Helfer noch Einsätze hat. Es wird in diesem Falle nur die Verlinkung zu Webling gelöscht.

Wenn ihr Helfer habt, welche nicht mit Webling verlinkt sind, findet ihr diese im Menüpunkt "Nicht mit Webling verlinkte Helfer".

Modus: lesen und Schreiben

In diesem Modus werden Anpassungen an Helferdaten SOFORT auf Webling geschrieben. Ändert also ein Helfer seine Telefonnummer, wird diese sofort auch in Webling angepasst.

Wichtig: Wenn ihr Webling im Lese und Schreibmodus verwendet, dann eröffnet Helfereinsatz mit jedem neuen Helfer einen neuen Datensatz in Webling. Ihr müsst sicherstellen, dass euer Limit in Webling ausreichend ist, was Adressen angeht. Denn 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 Helfern.

2. Helfer-Feld Zuweisung

Im zweiten Schritt der Einrichtung müssen die Felder zwischen Webling und Helfereinsatz zugewiesen werden. Helfereinsatz zeigt euch an, welche Felder Helfereinsatz braucht und ihr sucht euch im Dropdown das zugehörige Feld in Webling aus!

WICHTIG: Achtet beim Telefon darauf, dass Webling einen unterschied zwischen Telefon und Mobile kennt. Wir gehen davon aus, dass es für die Meisten von euch mehr Sinn macht, das Helfereinsatz-Telefon mit dem Webling-Mobile (statt dem Webling-Telefon) zu verknüpfen.

3. Gruppen Zuweisung

In Helfereinsatz und in Webling könnt ihr eure Vereinsmitglieder in Gruppen organisieren. Damit die Gruppen richtig "gematcht" werden, müsst ihr als dritten Schritt die Gruppen richtig zuordnen.

Webling Import-Gruppen

Ihr müsst nicht alle Mitglieder von Webling in Helfereinsatz importieren. Wollt ihr alle Webling Mitglieder importieren, wählt ihr bei der Webling Gruppe einfach "Mitglieder". Ihr könnt aber auch einfach 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 im "Lesen und Schreiben" verwendet, müsst ihr angeben, in welche Webling Gruppe ein neuer Helfer erfasst werden soll, wenn bei der Neueröffnung in Helfereinsatz KEINE Gruppe angegeben wurde. Im "nur Lesen" Modus müsst ihr hier nichts angeben.

Gruppen Zuweisungen

Als drittes müsst ihr bei jeder Helfereinsatz Gruppe bestimmen, welche Gruppe in Webling dazu korrespondiert.

4. Abschluss und Aktivierung

Nach der Konfiguration muss die Schnittstelle noch aktiviert werden. Sobald die Schnittstelle aktiv ist, werden täglich (um 3h morgens) 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: