API-Zugriff
Unter API-Zugriff erstellst du API-Tokens für Integrationen wie CRM-Systeme. Eine Integration meldet sich damit bei der Soulclick-API an, ohne das Passwort eines Admin-Kontos zu kennen. Jeder Token hat nur die Berechtigungen, die du ihm gibst, und läuft nach höchstens 2 Jahren ab. API-Zugriff sehen und verwalten nur Superuser.
Token erstellen
- Klicke auf API-Token hinzufügen.
- Gib einen Namen ein, zum Beispiel den Namen der Integration, und beschreibe unter Verwendungszweck, wofür der Token dient.
- Wähle unter Berechtigungen nur, was die Integration braucht.
- Lege unter Gültig bis das Ablaufdatum fest: 30 Tage, 90 Tage, 1 Jahr, 2 Jahre oder ein eigenes Datum. Der Token gilt bis Ende dieses Tages, höchstens 2 Jahre.
- Klicke auf Sichern.
Danach zeigt Soulclick den Token ein einziges Mal an. Kopiere ihn mit Kopieren und hinterlege ihn direkt in der Integration. Bestätige mit Ich habe den Token sicher gespeichert. und schliesse mit Fertig. Soulclick speichert den Token nicht im Klartext und kann ihn später nicht mehr anzeigen.
Berechtigungen
| Berechtigung | Erlaubt |
|---|---|
| Spenden und Kontaktdaten lesen | Spenden, die Spenden eines Kontakts, die Kontaktliste und die Stammdaten eines Kontakts lesen (customers:read) |
| Kontaktdaten bearbeiten | Stammdaten eines Kontakts ändern (customers:write, nur zusammen mit customers:read). Spenden lassen sich über die API nicht ändern |
| Newsletter-Anmeldungen lesen | Newsletter-Anmeldungen lesen (newsletter:read) |
Token verwenden
Die Integration sendet den Token bei jeder Anfrage im Header:
Authorization: Bearer sct_…Ein abgelaufener oder widerrufener Token erhält keinen Zugriff mehr. Fragt die Integration einen Bereich ab, für den der Token keine Berechtigung hat, wird die Anfrage abgelehnt.
Übersicht
Die Liste zeigt zu jedem Token den Namen, den Anfang des Tokens, die Berechtigungen, das Ablaufdatum, die letzte Verwendung und den Status:
| Status | Bedeutung |
|---|---|
| Aktiv | Der Token ist gültig. |
| Läuft bald ab | Der Token läuft in den nächsten 7 Tagen ab. |
| Abgelaufen | Das Ablaufdatum ist vorbei. |
| Widerrufen | Der Token wurde widerrufen. |
Standardmässig zeigt die Liste nur aktive Tokens. Über den Filter Nach Status siehst du auch abgelaufene und widerrufene.
Token erneuern
Ab 7 Tagen vor dem Ablaufdatum erhalten alle Superuser täglich eine Warnung per E-Mail mit einem Link zum Token. Sie hört auf, sobald der Token widerrufen oder abgelaufen ist.
- Öffne den Token und klicke auf Neuen Token erzeugen.
- Soulclick erstellt einen neuen Token mit denselben Berechtigungen und zeigt ihn einmal an.
- Hinterlege den neuen Token in der Integration.
- Widerrufe danach den alten Token.
Der alte Token gilt weiter, bis du ihn widerrufst. So wechselt die Integration ohne Unterbruch.
Token widerrufen
Öffne den Token und klicke auf Widerrufen, oder wähle in der Liste mehrere Tokens und die Aktion Ausgewählte API-Tokens widerrufen. Ein widerrufener Token ist sofort ungültig. Tokens lassen sich nicht löschen, damit nachvollziehbar bleibt, wer welchen Zugriff hatte.
Updated about 22 hours ago