In breve: puoi creare un contatto in Aivie facilmente tramite REST API inviando una richiesta POST all’endpoint /api/contacts/new e autenticandoti tramite Basic Auth o OAuth2.
Creare un contatto tramite API
Per creare un nuovo contatto, utilizza l’endpoint API:
POST /api/contacts/new
Un semplice esempio con curl è il seguente:
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"
}'
Importante:
- La richiesta deve essere inviata come
POST. - L’autenticazione avviene tramite Basic Auth o tramite OAuth2.
- L’header
Content-Type: application/jsondovrebbe essere impostato. - È richiesto almeno il campo
email.
Autenticazione
Per l’accesso all’API sono disponibili due varianti:
Basic Auth
Adatto per integrazioni semplici o sistemi interni. Qui vengono inviati un nome utente e una password codificati in Base64 nell’header Authorization.
OAuth2
Consigliato per integrazioni in produzione con sistemi esterni. OAuth2 offre un’autenticazione più sicura e flessibile.
Passare ulteriori campi
Oltre a email e firstname, puoi inviare anche altri campi come ad esempio:
- lastname
- company
- phone
- campi contatto personalizzati
inviare insieme. I nomi dei campi devono corrispondere esattamente all’alias del campo personalizzato.
Documentazione ufficiale
Tutti i campi disponibili, i codici di risposta e ulteriori esempi li trovi nella documentazione API ufficiale:
https://devdocs.mautic.org/en/5.x/rest_api/contacts.html#create-contact
Lì sono descritti anche esempi per SDK e casi d’uso più complessi.
Riepilogo
Un contatto viene creato tramite una richiesta POST a /api/contacts/new. L’autenticazione avviene tramite Basic Auth o OAuth2 e deve essere fornito almeno un indirizzo e-mail. Trovi la panoramica completa dei campi nella documentazione ufficiale delle API.
