Gruppen-Admin REST API

Willkommen zur offiziellen API-Dokumentation von Gruppen-Admin. Diese API ermöglicht es Ihnen, alle Funktionen von Gruppen-Admin programmatisch zu nutzen.

Quick Start

1. API-Key erhalten

Melden Sie sich an und erhalten Sie Ihren persönlichen API-Schlüssel. 

curl -X POST https://ihr-mandant.gruppen-admin.de/api/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin",
    "password": "your-password"
  }'
2. Ersten Request machen

Nutzen Sie Ihren API-Key für authentifizierte Requests. 

curl -X GET https://ihr-mandant.gruppen-admin.de/api/user \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Base URL

Alle API-Requests müssen an die folgende Base URL gesendet werden:

https://{ihr-mandant}.gruppen-admin.de/api

Ersetzen Sie {ihr-mandant} mit Ihrer Subdomain, z.B. kerzenheim.gruppen-admin.de/api

Authentifizierung

Die API verwendet Bearer Token Authentication mit Laravel Sanctum.

Header-Format:
Authorization: Bearer YOUR_API_KEY

Zur Authentifizierungs-Dokumentation

Request & Response Format

Request Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer YOUR_API_KEY
Response Format (Erfolg)
{
  "success": true,
  "message": "Operation erfolgreich",
  "data": {
    "id": 1,
    "name": "Beispiel"
  }
}
Response Format (Fehler)
{
  "success": false,
  "message": "Fehler beim Verarbeiten der Anfrage",
  "errors": {
    "email": ["Die E-Mail-Adresse ist ungültig"]
  }
}

Rate Limiting

Um Missbrauch zu verhindern, sind API-Requests limitiert:

  • Authentifizierte Requests: 60 Requests pro Minute
  • Nicht-authentifizierte Requests: 10 Requests pro Minute
Rate Limit Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1234567890
Bei Überschreitung des Limits erhalten Sie einen 429 Too Many Requests Fehler.

Verfügbare Endpoints

Benutzer

Benutzer verwalten, erstellen, bearbeiten und löschen
Mitglieder

Mitgliederdaten verwalten und abfragen
Termine

Events und Veranstaltungen verwalten
Kassenbuch

Finanzielle Transaktionen und Kassenstand
Nachrichten

Messaging-System für interne Kommunikation
Dokumente

Dateien hochladen, herunterladen und verwalten
Inventar

Inventarverwaltung für Geräte und Material
Support

Support-Tickets erstellen und verwalten

Code-Beispiele 

curl -X GET https://kerzenheim.gruppen-admin.de/api/user \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://kerzenheim.gruppen-admin.de/api/user', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ]
]);

$data = json_decode($response->getBody(), true);
const response = await fetch('https://kerzenheim.gruppen-admin.de/api/user', {
    method: 'GET',
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Accept': 'application/json'
    }
});

const data = await response.json();
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Accept': 'application/json'
}

response = requests.get(
    'https://kerzenheim.gruppen-admin.de/api/user',
    headers=headers
)

data = response.json()

Support & Kontakt

Bei Fragen oder Problemen mit der API stehen wir Ihnen gerne zur Verfügung: