Skip to content

API per servizi di email marketing

Questa API è stata sviluppata per integrare servizi esterni di email marketing. Consente di gestire liste di distribuzione e contatti tramite un unico endpoint (es.: https://yourserver.com/planfix_integration.php) e accetta richieste in formato JSON.

Una volta implementata l'integrazione, puoi contattare il nostro Servizio di supporto per aggiungere il tuo servizio all'elenco delle integrazioni disponibili per gli utenti nell'interfaccia Planfix.

Connessione a Planfix

  • Vai su Account management — Integrations — Email marketing per collegare e configurare l'integrazione.
  • Nella sezione aperta, seleziona Planfix API alla fine dell'elenco.
  • Si aprirà una finestra per le impostazioni dell'integrazione.
  • Devi specificare l'indirizzo al quale Planfix deve inviare le richieste e l'API Key per l'autorizzazione.

Formato della richiesta

La richiesta viene inviata tramite metodo POST in formato JSON all'indirizzo specificato nelle impostazioni dell'integrazione.

Esempio di richiesta: 

{
  "action": "action",
  "authToken": "your_authorization_token",
  "data": {
    // Dati a seconda dell'azione
  }
}

Parametri della richiesta:

Nome Descrizione Tipo/Formato dati Note
action Azione da eseguire string
authToken Token di autorizzazione per l'accesso all'API string
data Dati a seconda dell'azione object

Azioni supportate

createList — Crea una lista di distribuzione

Descrizione: Crea una nuova lista di distribuzione con il nome specificato.

Richiesta: 

{
  "action": "createList",
  "authToken": "your_authorization_token",
  "data": {
    "listName": "Nome lista"
  }
}

'Risposta (successo): 

{
  "success": true,
  "listId": "unique_list_identifier""
}

Risposta (errore): 

{
  "error": "Descrizione dell'errore"
}

deleteList — Elimina una lista di distribuzione

Descrizione: Elimina una lista di distribuzione tramite il suo identificatore.

Richiesta: 

{
  "action": "deleteList",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier"
  }
}

Risposta (successo): 

{
  "success": true
}

Risposta (errore): 

{
  "error": "Descrizione dell'errore"
}

importContacts — Importa contatti in una lista

Descrizione: Importa contatti nella lista di distribuzione specificata.

Richiesta: 

{
  "action": "importContacts",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Nome",
        "lastName": "Cognome"
      }
    ]
  }
}

Risposta (successo): 

{
  "success": true
}

Risposta (errore): 

{
  "error": "Descrizione dell'errore"
}

updateContact — Aggiorna il contatto

Descrizione: Aggiorna un contatto nella lista di distribuzione. Supporta le azioni: add, update, delete.


Richiesta: 

{
  "action": "updateContact",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "action": "add|update|delete",
    "contact": {
      "id": 123,
      "email": "email@example.com",
      "firstName": "Nome",
      "lastName": "Cognome"
    },
    "oldEmail": "old_email@example.com" // solo per action=update
  }
}

Risposta (successo): 

{
  "success": true
}

Risposta (errore): 

{
  "error": "Descrizione dell'errore"
}

Importante

  • Tutte le risposte devono essere restituite in formato JSON.
  • In caso di errore, deve sempre essere presente il campo "error" con la descrizione dell'errore.
  • In caso di successo, deve sempre essere presente il campo "success": true.
  • L'autorizzazione avviene tramite il campo "authToken" in ogni richiesta.
  • Tutti i campi testuali devono essere codificati in UTF-8.


Vai a

Estratto da "http://planfix.com/it/help/index.php?title=API_per_servizi_di_email_marketing&oldid=2682"