Was ist das Mitgliederportal?
Im Mitgliederportal können Mitglieder ihre eigenen Daten einsehen und bearbeiten. Welche Funktionen du anbietest (z.B. Kontaktdaten anpassen, Bankverbindung aktualisieren, Mitgliedschaft kündigen), legst du in den Einstellungen fest.
Das Mitgliederportal kommt ohne Passwort aus: Mitglieder melden sich über einen persönlichen, zeitlich begrenzt gültigen Link an. Wie lange der Link gültig ist, hängt davon ab, wie das Mitglied ihn erhält:
- Selbst angefordert (12 Stunden): Auf der Einstiegsseite des Mitgliederportals können Mitglieder unter Angabe ihrer E-Mail-Adresse einen Link anfordern.
- Per Mail (2 Wochen): Du verwendest den Platzhalter
[LINK ZUM MITGLIEDERPORTAL]in Rundmails und automatischen Mails. Die längere Gültigkeit lässt Mitgliedern genug Zeit, auf deine Mail zu reagieren. - Per API (12 Stunden): Du erstellst Links programmatisch, etwa um Mitglieder aus einem eigenen Login-Bereich oder einer App heraus ohne erneute Anmeldung ins Mitgliederportal weiterzuleiten.
Session erstellen
POST https://api.vereinsguru.com/member_portal_sessions
Erstellt eine neue Session im Mitgliederportal und gibt den persönlichen Link zurück, über den sich das Mitglied anmeldet.
Das Mitglied wird anhand genau eines der folgenden Identifier in der Mitgliederliste des Workspaces gesucht. Trifft der Identifier auf mehrere Mitglieder zu (z.B. eine Familie mit gemeinsamer E-Mail-Adresse), umfasst die Session alle diese Mitglieder.
Das Mitgliederportal steht nur für Mitglieder zur Verfügung, nicht für Kontakte.
Request Payload
| Key | Typ | Beschreibung |
|---|---|---|
person_id | String | Vereinsguru-eigene id des Mitglieds |
person_external_id | String | Eigene ID des Mitglieds (external_id) |
email | String | E-Mail-Adresse des Mitglieds (Ehemalige werden übersprungen) |
membership_number | String | Mitgliedsnummer des Mitglieds (membership_number) |
Genau einer dieser Keys muss übergeben werden.
{
"email": "maxi.muster@example.com"
}
Status Codes / Troubleshooting
| Status Code | Hinweis |
|---|---|
| 201 Created | Session erfolgreich erstellt |
| 402 Payment Required | Mitglieder sind nicht in der Variante des Vereinsguru-Abos enthalten |
| 403 Forbidden | Das Mitgliederportal ist deaktiviert, oder es gehört zu einem übergeordneten Workspace (z.B. dem Verband) |
| 404 Not Found | Es wurde kein Mitglied mit dem übergebenen Identifier gefunden |
| 422 Unprocessable Entity | Validierungsfehler, prüfe den Response Body für weiterführende Hinweise |
| und weitere |
Response (Beispiel)
urlenthält den persönlichen Link, über den das Mitglied angemeldet ins Portal gelangt. Leite das Mitglied direkt dorthin weiter oder sende ihm den Link über einen sicheren Kanal. Der Link ist 12 Stunden gültig, ermöglicht direkten Zugriff auf personenbezogene Daten und sollte deshalb wie ein Passwort behandelt werden.person_idsenthält die IDs aller Mitglieder, die über diese Session verwaltet werden können.
{
"data": {
"url": "https://on.vereinsguru.com/jugend-musterstadt-ev/portal/Xk3vQ9aLmB7tRz2cWn5dHp8fJs1yUo4eGi6qNb0A",
"person_ids": [
"per_2GvVo1c9CvwKBzMfkTOh",
"per_9KjLm3PqRt7VwXy1ZaBc"
]
}
}