Lyhyesti sanottuna: Voit luoda yhteydenoton Aivieen helposti REST API:n kautta lähettämällä POST-pyynnön päätepisteeseen /api/contacts/new ja tunnistautumalla Basic Auth- tai OAuth2-tunnistautumisen avulla.
Luo yhteyshenkilö API:n kautta
Voit luoda uuden yhteystiedon API-päätepisteen avulla:
POST /api/contacts/new
Yksinkertainen esimerkki curl näyttää seuraavalta:
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"
}'
Tärkeää:
- Pyyntö on lähetettävä osoitteessa
POST. - Tunnistautuminen tapahtuu joko Basic Auth- tai OAuth2-tunnistautumisen avulla .
- Otsikko
Content-Type: application/jsonolisi asetettava. - Ainakin kenttä
emailon pakollinen.
Tunnistus
API:n käyttämiseen on käytettävissä kaksi vaihtoehtoa:
Basic Auth
Sopii yksinkertaisiin integraatioihin tai sisäisiin järjestelmiin. Valtuutusotsakkeessa lähetetään Base64-koodattu käyttäjänimi ja salasana.
OAuth2
Suositellaan tuottaviin integraatioihin ulkoisten järjestelmien kanssa. OAuth2 tarjoaa turvallisemman ja joustavammin hallittavissa olevan todennuksen.
Siirrä lisäkenttiä
email ja firstname lisäksi voit lisätä myös muita kenttiä, kuten:
- sukunimi
- yritys
- puhelin
- Omat räätälöidyt yhteystietokentät
lähetä mukaan. Kenttien nimien on vastattava täsmälleen käyttäjän määrittelemän kentän aliasta.
Viralliset asiakirjat
Kaikki käytettävissä olevat kentät, vastauskoodit ja lisäesimerkkejä on saatavilla API:n virallisessa dokumentaatiossa:
https://devdocs.mautic.org/en/5.x/rest_api/contacts.html#create-contact
Siellä kuvataan myös esimerkkejä SDK:ista ja monimutkaisemmista käyttötapauksista.
Yhteenveto
Yhteyshenkilö luodaan POST-pyynnöllä osoitteeseen /api/contacts/new. Tunnistautuminen tapahtuu Basic Auth- tai OAuth2-tunnistautumisen avulla, ja vähintään yksi sähköpostiosoite on annettava. Täydellinen kenttien yleiskatsaus löytyy API:n virallisesta dokumentaatiosta.
