Kurz gesagt: Einen Kontakt kannst du in Aivie ganz einfach über die REST API anlegen, indem du einen POST Request an den Endpoint /api/contacts/new sendest und dich per Basic Auth oder OAuth2 authentifizierst.
Kontakt per API anlegen
Um einen neuen Kontakt zu erstellen, verwendest du den API Endpoint:
POST /api/contacts/new
Ein einfaches Beispiel mit curl sieht so aus:
curl --location 'https://aivie-v6.0.ddev.site/api/contacts/new' \
--header 'Authorization: Basic VVNF***==' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "aivie@dev.ch",
"firstname": "aivie"
}'
Wichtig:
- Der Request muss als
POSTgesendet werden. - Die Authentifizierung erfolgt entweder über Basic Auth oder über OAuth2.
- Der Header
Content-Type: application/jsonsollte gesetzt sein. - Mindestens das Feld
emailist erforderlich.
Authentifizierung
Für den Zugriff auf die API stehen zwei Varianten zur Verfügung:
Basic Auth
Geeignet für einfache Integrationen oder interne Systeme. Hier wird ein Base64-kodierter Benutzername und ein Passwort im Authorization Header mitgesendet.
OAuth2
Empfohlen für produktive Integrationen mit externen Systemen. OAuth2 bietet eine sicherere und flexibel steuerbare Authentifizierung.
Weitere Felder übergeben
Neben email und firstname kannst du auch weitere Felder wie zum Beispiel:
- lastname
- company
- phone
- eigene benutzerdefinierte Kontaktfelder
mitsenden. Die Feldnamen müssen exakt dem Alias des Benutzerdefinierten Feldes entsprechen.
Offizielle Dokumentation
Alle verfügbaren Felder, Response Codes und weitere Beispiele findest du in der offiziellen API Dokumentation:
https://devdocs.mautic.org/en/5.x/rest_api/contacts.html#create-contact
Dort sind auch Beispiele für SDKs und komplexere Anwendungsfälle beschrieben.
Zusammenfassung
Ein Kontakt wird über einen POST Request an /api/contacts/new erstellt. Die Authentifizierung erfolgt per Basic Auth oder OAuth2, und mindestens eine E-Mail-Adresse muss übergeben werden. Die vollständige Feldübersicht findest du in der offiziellen API-Dokumentation.
