Come creare una lista tramite API

Tempo di lettura: 5 minuti

Difficoltà: Avanzata

Tramite le API di 4Dem puoi creare una lista sull’ account della tua console in modo rapido e veloce, vediamo insieme i vari passaggi.

In questa guida:

Login e creazione 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.

Autenticazione

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

Creazione della lista

Controlla quante liste prevede il tuo piano

Per verificare se c’è la possibilità di creare una lista sul proprio account è opportuno utilizzare l’endpoint GET /recipients (https://api.4dem.it/#!/Recipients/recipients_index) controllando il numero di liste attualmente disponibili sull’account. Solo a questo punto è opportuno procedere nella creazione di una nuova lista.

Per effettuare la chiamata puoi utilizzare i seguenti parametri:

Method:

POST

Url:

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

Body:

{
  "name": "nome della mia lista",
 }

Attento al nome della lista

Non è possibile creare una lista con un nome già esistente. Nel caso in cui si provasse a farlo, le API rispondono con un errore 400 e il messaggio “The name has already been taken.”

Esempio di risposta:

La risposta restituisce l’id della lista appena creata. Se la creazione non dovesse andare a buon fine, nel response body viene data traccia del motivo di errore.

Riassumendo

  • Effettua il login in console e genera un api key.
  • Effettua l'autenticazione.
  • Controlla quante liste prevede il tuo piano.
  • Vai alla documentazione https://api.4dem.it/#!/Recipients/recipients_store.
  • Method = POST
  • URL = https://api.4dem.it/recipients?token={{token}}
  • Body = { "name": "nome della mia lista",}.
  • Non puoi creare una lista con il medesimo nome di una già esistente.
  • Se la creazione non dovesse andare a buon fine, nel response body viene data traccia del motivo di errore.