Comment puis-je créer un contact via l’API dans Aivie ?

En bref : vous pouvez créer un contact dans Aivie très facilement via l’API REST en envoyant une requête POST au point de terminaison /api/contacts/new et en vous authentifiant par Basic Auth ou OAuth2.

Créer un contact via l’API

Pour créer un nouveau contact, utilisez le point de terminaison API :

POST /api/contacts/new

Un exemple simple avec curl ressemble à ceci :

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"
}'

Important :

• La requête doit être envoyée en tant que POST.
• L’authentification s’effectue soit par Basic Auth, soit par OAuth2.
• L’en-tête Content-Type: application/json doit être défini.
• Le champ email est au minimum requis.

Authentification

Deux variantes sont disponibles pour accéder à l’API :

Basic Auth
Adapté aux intégrations simples ou aux systèmes internes. Ici, un nom d’utilisateur et un mot de passe encodés en Base64 sont transmis dans l’en-tête Authorization.

OAuth2
Recommandé pour les intégrations en production avec des systèmes externes. OAuth2 offre une authentification plus sûre et flexible.

Transmettre des champs supplémentaires

Outre email et firstname, vous pouvez également transmettre d’autres champs tels que :

• lastname
• company
• phone
• vos propres champs de contact personnalisés

inclure. Les noms des champs doivent correspondre exactement à l’alias du champ personnalisé.

Documentation officielle

Tous les champs disponibles, les codes de réponse et d’autres exemples se trouvent dans la documentation officielle de l’API :

https://devdocs.mautic.org/en/5.x/rest_api/contacts.html#create-contact

Des exemples de SDK et de cas d’utilisation plus complexes y sont également décrits.

Résumé

Un contact est créé via une requête POST vers /api/contacts/new. L’authentification s’effectue via Basic Auth ou OAuth2, et au moins une adresse e-mail doit être transmise. Vous trouverez la liste complète des champs dans la documentation officielle de l’API.