API-Referenz

Soulclick bietet eine REST-API für den programmatischen Zugriff auf Spenden- und Kontaktdaten. Die API eignet sich für CRM-Integrationen, Reporting-Tools und eigene Auswertungen.

Interaktive API-Dokumentation

Die vollständige, interaktive API-Referenz findest du hier:

API-Referenz öffnen

Dort kannst du alle Endpunkte, Parameter und Response-Formate einsehen und direkt testen.

Authentifizierung

Die API unterstützt zwei Authentifizierungsmethoden:

Methode	Beschreibung
JWT Bearer Token	Token-basierte Authentifizierung (empfohlen für automatisierte Zugriffe)
HTTP Basic Auth	Benutzername und Passwort eines Admin-Kontos

Für die API ist ein Admin-Konto erforderlich. Erstelle bei Bedarf ein separates Konto mit eingeschränkten Rechten für API-Zugriffe.

Swagger auf deiner Instanz

Zusätzlich zur API-Referenz oben steht auf jeder Soulclick-Instanz eine Swagger-UI bereit:

https://deine-soulclick-instanz.ch/crm-api/swagger/

Dort kannst du Anfragen direkt gegen deine eigene Instanz testen.