come creare campi personalizzati 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:

Prima di cominciare

Non è possibile creare un campo personalizzato su una lista che non esiste. Prima di procedere alla creazione di un campo personalizzato occorre creare una lista e recuperare il suo id.

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 del campo personalizzato

Documentazione:

https://api.4dem.it/#!/Custom_Fields/customfields_store

Method:

POST

Url:

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

Body:

{
  "recipient_id": {{id-lista}},
  "name": "nome campo",
  "global": false,
  "type": "Single line"
}

Il parametro “global” se impostato a “false” crea un campo personalizzato locale, se impostato a “true” crea un campo personalizzato globale. Guardare la guida relativa ai campi personalizzati su university per approfondire questa differenza.

Il type indica il tipo di campo personalizzato che si vuole creare. Far riferimento alla documentazione API per l’elenco completo di tutti i tipi disponibili.

Una lista può avere due campi personalizzati diversi con lo stesso nome è quindi buona norma chiamare i campi personalizzati con nomi differenti e facilmente riconoscibili per distinguerli facilmente.

Esempio di risposta:

Riassumendo