Externe APIs
Die Vereinsverwaltung Webling bietet eine API-Schnittstelle an, welche in Helfereinsatz eingebunden werden kann.
Webling
Damit ihr Helfereinsatz und Webling verknüpfen könnt, müsst ihr bei Webling erst den API-Key erzeugen. Dazu geht ihr in der Hauptnavigation auf "Administration". In der Seitennavigation findet ihr unter "Aboverwaltung" den Punkt "API". Da könnt ihr dem Key eine Beschreibung geben und die Zugriffsrechte verwalten. Helfereinsatz benötigt Zugriff auf die Mitgliederdaten. Folgende Optionen habt ihr:
- Alle Mitglieder lesen - Helfereinsatz kann die Daten sämtlicher Mitglieder aus Webling auslesen
- Alle Mitglieder lesen und schreiben - Helfereinsatz kann die Daten sämtlicher Mitglieder auslesen und bearbeiten
- Benutzerdefiniert - Ihr definiert, welche Mitgliedergruppen freigegeben und bei welchen Lese- oder Schreibrechte gelten sollen
Buchhaltung, Termine und Material müssen nicht freigegeben werden.
Sobald der Key definiert wurde, findet ihr ihn in der Liste und könnt ihn mittels Klick auf das Schlüsselsymbol im Bearbeitungsfenster kopieren.
Helfereinsatz
Sobald ihr den Key von Webling kopiert habt, könnt ihr in Helfereinsatz den "Jetzt einrichten"-Button klicken. Ihr könnt nun auf Seite Helfereinsatz nochmals definieren, welche Rechte Helfereinsatz auf die Daten von Webling hat (Lese- oder Schreibrecht). WICHTIG: Wenn ihr Webling nur Leserechte definiert habt, könnt ihr in Helfereinsatz keine Schreibrechte aktivieren. Anschliessend gebt ihr noch eure Webling Subdomain und den entsprechenden Key ein und klickt speichern.
Helfer-Feld-Zuweisung bearbeiten
Nun gelangt ihr zur Zuweisung der Helferfelder. Verknüpft nun die Weblingfelder, die ihr importieren wollt, mit den entsprechenden Helfereinsatz-Feldern.
Ohne vorgängige Bearbeitung sind in Helfereinsatz nur gewisse Felder (E-Mail, Vorname, Nachname...) verfügbar. Um weitere Felder zu importieren, müssen die erst in Helfereinsatz unter "Organisation" - "Helferdaten" als Freifelder erstellt werden. Die Felder, die ihr auf Seite Helfereinsatz nicht benötigt, müsst ihr auch nicht verknüpfen. Obligatorisch sind nur Vorname, Nachname und Mailadresse.
Gruppen zuordnen
Wenn ihr die Feldzuweisung abgeschlossen habt, werded ihr zur Gruppenzuordnung weitergeleitet. Hier könnt ihr, analog der Rechtevergabe in Webling, definieren, ob nur von bestimmten Gruppen Datensätze importiert werden sollen. WICHTIG: Die Einstellungen, welche bei der API-Erstellung in Webling definiert wurden, können in Helfereinsatz nicht übersteuert werden.
Wenn ihr alle (zur Verfügung stehenden) Gruppen imporieren wollt, könnt ihr sie nun den entsprechenden Helfereinsatz-Gruppen zuordnen. Gleich wie bei den Helferfelder müssen die Helfereinsatz-Gruppen vorgängig erstellt worden sein, damit sie mit den Webling-Gruppen gekoppelt werden können. Gruppen, welche nicht gekoppelt werden sollen, können im Status "nicht verknüpft" belassen werden.
Hauptkonfiguration
Ist die Gruppenzuweisung abgeschlossen, gelangt ihr in die Hauptkonfiguration. Hier könnt ihr alles prüfen, erhaltet Infos über Mögliche zusätzliche Zuordnungen und könnt bei Bedarf noch Anpassungen machen.
Aktivierung
Wenn alles passt, könnt ihr zurück zum Navigationspunkt "Externe APIs" und dort auf "aktivieren" klicken. Wenn ihr den ersten Webling-Import bereits anstossen wollt, könnt ihr auf "Import ausführen" klicken. Dann startet der erste Import sofort, was einige Minuten dauern kann.
Handhabung Schnittstelle
Informationen
Wenn ihr die Schnittstelle aktiviert habt, findet ihr unter "Externe APIs" gewisse Informationen:
- Modus - Hat Helfereinsatz Lese- oder Schreibrechte auf Webling?
- Letzter Import - Wann fand der letzte Import statt, und wie viele Helfenden wurden importiert?
- Optionale Zuordnungen - Falls es Helfereinsatz-Felder gibt, die nicht verknüpft sind, wird euch das angezeigt. Das ist rein informativ, falls ihr die nicht verknüpfen wollt.
- Import-Fehler - Falls es beim letzten Import Fehler gab, wird euch das angezeigt und um Überprüfung gebeten.
- Helfer, die nicht mit Webling verknüpft sind - Das findet ihr ganz unten auf dieser Übersicht. Mittels Klick gelangt ihr auf die Liste der Helfenden, welche wohl bei Helfereinsatz registriert aber nicht mit Webling verknüpft sind.
Importverhalten
Wenn ihr Lese- und Schreibrechte für Helfereinsatz aktiviert habt (sowohl in der Schnittstelleneinstellung in Webling als auch in der Konfiguration in Helfereinsatz), werden Anpassungen, welche ihr oder eure Helfenden in Helfereinsatz machen, immer direkt an Webling übergeben.
Der Import von Webling findet jeweils über Nacht, kurz nach Mitternacht statt. Anpassungen bei Webling werden also erst im nächsten Import an Helfereisnatz übergeben.
Helfendenbearbeitung
Wenn ihr nur Leserechte definiert habt, könnt ihr verknüpfte Helfende nach der Schnittstellenaktivierung in Helfereinsatz nicht mehr bearbeiten. jetzt gilt Webling als Master und übergibt nur Informationen an Helfereinsatz - Mutationen bei Mitgliedern werden in Webling gepflegt.