CiviCRM API Key erstellen

Ich verwende erst seit kurzem die Software CiviCRM für unsere Organisation. Bei mehreren Erweiterungen muss ja der
|CiviCRM Site Key|||
| — | — | — | —zu finden in der civicrm.settings.php
sowie
|CiviCRM API Key|

eingepflegt werden.

Gibt es irgendwo eine detaillierte Beschreibung wie man diese API-Key für die Plugins erstellt.
z.B. Contact Form 7 (Onlineformular)

Die entsprechende Erweiterung haben wir bereits aktiviert.
Kommen aber mit dem Tool nicht so ganz zurecht. Vielen Dank

Hallo und willkommen,

jeder API-Key ist einem bestimmten Kontaktdatensatz bzw. Benutzer-Account zugeordnet, wird also für einen CiviCRM-Kontakt erstellt. Es bietet sich an, extra für den jeweiligen Dienst einen neuen CMS-Benutzer zu erstellen. Also für Contact Form 7 beispielweise einen CMS-Account namens „cf7 API User“ o.ä. Dieser Account bekommt dann automatisch einen neuen Kontakt im CiviCRM und für diesen erstellt man dann den API-Key. Das macht deswegen Sinn, weil so für diesen „Benutzer“ von allen anderen Benutzern separate Berechtigungen bestimmt werden können, die nur das erlauben, was der Dienst im CiviCRM können darf/muss.

In Vorbereitung auf die eigentliche Zuweisung des Keys schaut man die CiviCRM-ID des neu erstellten Kontakts nach und erstellt sich einen mindestens 20 Zeichen langen String aus zufällig zusammengewürfelten großen und kleinen Buchstaben sowie Zahlen (z.B. mit einem Passwortgenerator).

Dann navigiert man im CiviCRM in den API4-Explorer (Unterstützung > Entwickler > API-Explorer v4), wählt bei Entität „Contact“ und bei Aktion „update“ aus, setzt die ID für den zuvor erstellten Kontakt und wählt unter „Values“ aus dem Dropdwon „api_key“ und fügt den zuvor bereitgelegten String ein. Anschließend einmal auf „Ausführen“ klicken.

Im Prinzip macht man damit nichts anderes, als dem Kontakt mit der gesetzten ID einen API-Key zuzuweisen. Dieser Key kann dann neben dem Site-Key bei der Konfiguration des Dienstes benutzt werden.

Es gibt auch eine CiviCRM-Erweiterung für diese Aufgabe → API key Extension, die ich persönlich aber nie ausprobiert habe.

Viele Grüße
Romy

Hallo,

wir nutzen die API Keys für die Integration von Civi in Outlook und zwar mit der Erweiterung API Key Management.

Da hast du dann in jedem Kontakt einen deaktivierten Reiter
API Key

Klickst du darauf erscheint ein Button „+ Add API Key“ und einen Klick weiter kannst du dann einfach einen Schlüssel generieren lassen und danach verwenden.

Klappt prima!

Viel Erfolg und herzliche Grüße,
Regina Sommerfeld
Stiftung Aktive Bürgerschaft


System: CiviCRM 5.58.1 mit WordPress 6.2.2

1 „Gefällt mir“