14.1 easyVerein API (Programmierschnittstelle)

easyVerein API, API, Programmierschnittstelle

Kann grundsätzlich mit jedem Funktionsumfang genutzt werden, je nach Funktionsumfang natürlich mit eingeschränkten Möglichkeiten.

Für die Nutzung der easyVerein API muss eine Administratorgruppe zwingend gesetzt werden, die darin gesetzten Berechtigungen gelten dann auch bei Anwendung der API.

https://easyverein.com/app/settings/easyVereinApi/

Unsere Programmierschnittstelle (API) erlaubt es euch, Informationen eures Vereins abzurufen oder zu verändern und so eine tiefe Integration zwischen easyVerein und anderen Anwendungen herzustellen.

Die API befindet sich aktuell noch in der Testphase und steht zahlenden Kunden bzw. Demo-Kunden auf Anfrage zur Verfügung.

Wenn ihr selbst nicht über die notwendigen Programmierkenntnisse zur Anwendung der API verfügt, könnt ihr auf unseren kostenpflichtigen Service zur Besprechung und Umsetzung eurer Vorhaben zurückgreifen.

Bucht hier euren Termin mit unseren Schnittstellenexperten.

Unten links auf der Seite könnt ihr zwei E-Mail-Adressen hinterlegen, die wir bei wichtigen Anpassungen der API über einen E-Mail-Verteiler informieren. Gebt zum Beispiel eine Mailadresse vom API-Verantwortlichen eures Vereins und eine Mailadresse eures technischen Dienstleisters, falls ihr die API-Scripts nicht selbst programmiert.

Hinweis:
Eine Benachrichtigung an die beiden hinterlegten E-Mail-Adressen erfolgt nur, wenn zum Zeitpunkt unserer geplanten Information mindestens ein aktiver API-Schlüssel existiert.

Um die easyVerein API steuern zu können, muss ein sogenannter API-Schlüssel generiert werden.

Wählt dazu im 1. Schritt die gewünschte Administratorgruppe, für die der API-Schlüssel erzeugt werden soll. Administratorgruppen werden in der Gruppenverwaltung erstellt.

Im 2. Schritt könnt ihr einen neuen API-Schlüssel erzeugen oder einen bestehenden löschen.

Achtung:

Mit Hilfe des hier generierten API-Schlüssels können weitreichend Daten aus easyVerein ausgelesen und verändert werden. Ein API-Schlüssel gewährt Zugriffe komplett analog zu einem Administrator-Account mit den entsprechenden Rechten.

Jeder Aufruf, der mit dem unten stehenden API-Schlüssel verifiziert wird, ist eine Weisung zur Datenverarbeitung gemäß des aktuellen Auftragsverarbeitungsvertrags.

Seid vorsichtig bei der Weitergabe oder Verwendung dieses Schlüssels. Wir können keine Verantwortung für die über die Schnittstelle angestoßenen Prozesse oder angebundene Drittanbietersoftware übernehmen.

Stellt sicher, dass die von euch gewählte Administratorgruppe genau über die von euch gewünschten Berechtigungen verfügt. Wir empfehlen für die API eine eigene Administratorgruppe anzulegen.

Die Administratorgruppe kann auch geändert werden, ohne dass ein neuer API-Schlüssel generiert werden muss.

Es wird empfohlen, je Anwendungsfall einen separaten Schlüssel zu generieren. Neue API Schlüssel haben ein Verfallsdatum und sind nur noch 30 Tage lang gültig. Vor Ablauf dieser Frist (ab dem 15. Tag) sollten die Schlüssel erneuert werden. Mehr Infos dazu stehen in der API Dokumentation.

Über den grünen Button am Ende der Seite gelangt ihr zur Dokumentation unserer API:

Der Button verlinkt zur Seite https://easyverein.com/api/documentation/, die jedoch aus Sicherheitsgründen nur geöffnet werden kann, wenn ihr gleichzeitig in eurem easyVerein-Account eingeloggt seid.

Unten auf der Seite findet ihr die Links zur Dokumentation der verschiedenen API-Versionen.

Achtet stets darauf, welche Version unserer API ihr verwendet.

Die neuste Version (latest) enthält mehr Funktionen und wird von uns fortlaufend weiterentwickelt. Durch unsere Updates können aber auch vorhandene Scripts, die auf dieser Version basieren, unbrauchbar werden.

An der vorherigen Version (stable) wird von uns nicht mehr aktiv gearbeitet, es findet lediglich Fehlerbehebung statt. Auf dieser Version basierende Scripts werden also auch langfristig funktionieren. Dafür können in dieser Version Funktionen und Endpunkte fehlen, die in der neusten Version mittlerweile vorhanden sind.

Was ist eine API?

Was kann ich mit der easyVerein API machen?

Verursacht die Nutzung der easyVerein API zusätzliche Kosten?

Welche Programmierkenntnisse brauche ich um sicher selbstständig mit der API arbeiten zu können?

Welche Vorteile bietet eine Erstellung von Daten über die API?

Muss eine Website bestimmte Anforderungen erfüllen um Infos über die easyVerein API anzeigen zu können?

14.4 Website Integration

Wendet euch für weitere Informationen gerne an unser Support-Team.