In questo articolo elenchiamo i 4 passaggi da seguire per esportare un database di disiscritti degli ultimi 7 giorni, ad esempio.
Come realizzare un export via API su Mindbaz
Per poter effettuare un export via API, è necessario disporre di un account API.
Se, al momento della creazione del database, avete richiesto un accesso API nel modulo di apertura, un account API è già stato creato e le credenziali vi sono state inviate.
Se invece non avete richiesto l'accesso API o non ricordate la password, contattate il vostro amministratore per creare un nuovo accesso o reimpostare la password dell'account API.
⚠️ Ogni database può avere al massimo due account API:
- Uno con accesso completo
- Uno con accesso limitato
👉 Trovate qui la gestione completa degli account API per la vostra azienda
Le 4 fasi per effettuare un export via API
Per ogni fase, troverete un link alla documentazione API con l'elenco dei parametri e degli operatori necessari per personalizzare l'export in base alle vostre esigenze.
1. Autenticazione e recupero del Token API
Per eseguire richieste API, dovete prima ottenere il Token di autenticazione.
👉 Guida dettagliata qui
2. Creazione di un target nell'API
⚠️ Le fasi 2 e 3 sono necessarie solo nella fase di configurazione iniziale. Non è necessario ricreare il target per ogni export, potete riutilizzarlo.
Per creare un target tramite API, utilizzate il seguente endpoint:
📌 POST api/{idsite}/Targets
👉 Guida dettagliata qui
🛑 Importante:
- Quando create un target, inizialmente non ha filtri e quindi non è utilizzabile.
- È necessario aggiungere almeno un filtro affinché il target sia valido.
3. Aggiunta dei filtri al target
📌 Endpoint da utilizzare:
POST api/{idsite}/targetfilters/{idTarget}/field
Per esportare i contatti disiscritti negli ultimi 7 giorni, aggiungete i seguenti due criteri:
- Stato dell’abbonato = disiscritto o disiscritto manualmente
- (Valori separati da ";" per esprimere il condizionale "oppure")
- Data di disiscrizione = meno di 7 giorni fa
Esempio di parametri per l’aggiunta di questi filtri (dove XXXX è l’ID del target creato in precedenza):
{
"idTarget": XXXX,
"isEnabled": true,
"filters": [
{
"idField": 7,
"operator": 3,
"value": "1;2"
},
{
"idField": 4,
"operator": 11,
"value": "7"
}
]
}
👉 Guida dettagliata qui
4. Esportazione del target
Per esportare il target, utilizzate l’endpoint:
📌 POST api/{idsite}/exports/subscribers
L’API di esportazione consente di esportare una lista di email con i loro campi associati.
🔹 Parametri richiesti:
- ID del target da esportare
- Nome del file da esportare
- Campi da includere
- Destinazione su SFTP
- Tipo di encoding
- Frequenza di esportazione
👉 Elenco completo dei parametri qui
Una volta impostata la chiamata API, sarà sufficiente programmare l’esecuzione automatica con la frequenza desiderata.
📌 Esempio: Se volete esportare i contatti disiscritti negli ultimi 7 giorni, dovrete eseguire l’export ogni 7 giorni.