Come iscrivere un contatto in una lista tramite API

Tempo di lettura: 5 minuti

Difficoltà: Avanzata

Questa guida è utile se vuoi utilizzare le API di 4Dem per iscrivere contatti in una lista della piattaforma in modo automatico dal tuo sito web personale. Prima di cominciare assicurati di aver già creato la lista sui cui importare i contatti.

In questa guida:

Creare un Api Key

Il primo passo è generare sulla tua tua console un Api Key per effettuare l'autenticazione.

Per creare o gestire un api key accedi dalla tua console alla sezione "Api Key" che trovi all'interno dell'icona "Strumenti", quindi fai click su "AGGIUNGI".

Limita un indirizzo IP

È possibile limitare l'accesso alla tua Api Key da uno specifico indirizzo IP inserendolo nell'apposito campo del popup di creazione dell' api key.

Autenticarsi su 4Dem

Generata un Api Key dovrai effettuare l'autenticazione su 4Dem.

Per effettuare la chiamata http puoi utilizzare i seguenti parametri:

Method:

POST

Url:

https://api.4dem.it/authenticate

Body:

{"APIKey":"la-tua-api-key"}

Esempio di risposta:

Per la documentazione completa puoi consultare: https://api.4dem.it/#!/Authentication/authenticate

Iscrivi un contatto in lista

Per effettuare la chiamata http puoi utilizzare i seguenti parametri:

Method:

POST

Url:

https://api.4dem.it/recipients/{{id_lista}}/subscribe?token={{token}}

Body:

{
 "email_address": "emailtest@domain.dev",
 "mobile": "+393331111111",
 "subscription": {
   "ip": "80.80.80.80",
   "status": "Subscribed",
   "date": "2018-05-05 15:00:00"
 },
 "triggers": {
   "automation": true,
   "behaviors": true
 },
 "update_if_duplicate": false,
 "custom_fields": [
   {
     "id": 2323,
     "value": "value of cf"
   }
 ]
}

I tipi di status nell’oggetto “subscription” del body sono:

  • Opt-In Pending
  • Subscribed
  • Opt-Out Pending
  • Unsubscribed
Gli status devono essere congruenti alle impostazioni della lista usata.

Esempio: Se la lista è di tipo Single opt-in lo status Opt-In Pending risulta inutile.

Per la documentazione completa puoi consultare: https://api.4dem.it/#!/Contacts/subscribers_store

Numero di telefono

Il numero di telefono deve essere un numero corretto e veritiero. Non vengono accettati numeri di telefono del tipo +391234567890 o +391111111111

Esempio di risposta:

Mancata iscrizione

La risposta restituisce l’id del contatto appena iscritto. Se l’iscrizione non dovesse andare a buon fine, nel response body viene data traccia del motivo di errore.

Riassumendo:

  • Genera l'api key dalla console
  • Effettua l' autenticazione utilizzando i parametri forniti oppure consulta la documentazione completa
  • Iscrivi il contatto utilizza utilizzando i parametri forniti oppure consulta la documentazione completa