Come utilizzare l'API (Application Programming Interface) pubblica di systeme.io

In questo articolo, imparerai come configurare e utilizzare l'API pubblica di systeme.io, inclusa la generazione delle chiavi API e le azioni che puoi eseguire.

  1. Cos'è un'API?

    L'acronimo API sta per "Application Programming Interface" (Interfaccia di Programmazione delle Applicazioni), una serie di istruzioni tramite le quali una piattaforma offre servizi ad altre piattaforme. È un gateway strategico per gli sviluppatori esterni, che consente loro di accedere a funzionalità o dati specifici di una piattaforma in modo strutturato e sicuro. È come un insieme di strumenti pronti all'uso che semplificano la creazione di nuove applicazioni, servizi o combinazioni.

In breve, systeme.io si apre ad altre piattaforme per offrire i suoi servizi laddove apporta valore aggiunto.

  1. Come funziona la nostra API pubblica?

    La nostra API espone un set di funzionalità accuratamente selezionate, consentendo agli sviluppatori di interagire con la nostra piattaforma in modo trasparente ed efficiente. Se desideri saperne di più sul suo funzionamento, puoi consultare la nostra documentazione API ufficiale.

  2. Come generare le chiavi API

    Le chiavi API sono identificatori univoci che autenticano le richieste alla nostra API pubblica. Consentono di accedere e gestire a livello programmatico diverse risorse sulla nostra piattaforma.

Per creare una chiave API pubblica, fai clic sulla tua immagine del profilo, seleziona Impostazioni (1) e scorri verso il basso fino a Chiavi MCP e API (2).

Click Create (3) to start creating a public API key.

Nella finestra a comparsa "Crea chiave API pubblica", inserisci un nome e seleziona una data e un'ora di scadenza per la tua chiave API.

Una volta terminato, fai clic su Salva (4).

Nota: per mantenere attiva la tua chiave API a tempo indeterminato, lascia vuoto il campo "Scadenza".

La tua chiave è ora pronta.

  1. Cosa puoi fare con la nostra API?

    La nostra API apre alcune interessanti possibilità. Di seguito troverai le principali azioni che puoi eseguire utilizzando la nostra API pubblica:a. Contatti, tag e campi personalizzati:Gestisci i contatti: crea nuovi contatti, aggiorna quelli esistenti, elenca il tuo pubblico con filtri avanzati o elimina i contatti.


Gestisci i tag: crea, assegna, elenca e rimuovi i tag dai contatti.

Campi personalizzati: recupera i campi personalizzati dei contatti disponibili e i relativi identificatori (slug) per compilare correttamente le informazioni di contatto.

b. Newsletter:

Crea e aggiorna le newsletter: crea nuove bozze di newsletter o aggiorna parzialmente quelle esistenti. Puoi definire il tipo di editor (Classico o Visuale), recuperare il contenuto HTML completo e impostare esplicitamente il nome e l'indirizzo email del mittente.

Elenca e recupera: sfoglia le tue newsletter esistenti o recupera il contenuto completo di una newsletter specifica utilizzando il suo ID.

c. Editor di funnel e pagine:

Gestisci i funnel: crea nuovi funnel, aggiungi nuovi passaggi (pagine) e recupera un elenco di tutti i singoli passaggi all'interno di un funnel specifico.

Editor di pagine: salva il contenuto della pagina generato direttamente nei passaggi del funnel o nelle pagine del sito web (sostituzione completa) e recupera gli schemi JSON per specifici tipi di pagina.

d. Piani tariffari e coupon:

Crea, modifica ed elimina: genera nuovi piani tariffari e coupon, oppure aggiorna parzialmente ed elimina quelli esistenti.

Elenca e cerca: sfoglia tutti i piani tariffari e i coupon esistenti o recupera elementi specifici tramite il loro ID.

e. Corsi e studenti:

Gestisci corsi e studenti: recupera un elenco dei corsi esistenti e un elenco degli studenti attualmente iscritti.

Iscrivi studenti: iscrivi automaticamente i contatti ai singoli corsi.

Nota sui corsi: il supporto per i pacchetti di corsi verrà aggiunto in un futuro aggiornamento.

f. Community:

Gestisci le community: recupera un elenco delle tue community esistenti e accedi a un elenco dei membri attuali di una community specifica.

Invita membri: invita programmaticamente nuovi utenti a unirsi alle tue community fornendo il loro ID di contatto

g. Regole di automazione:

Gestisci le regole: collega programmaticamente eventi e azioni comuni, aggiorna le regole esistenti (ad esempio, modificando un'azione mantenendo lo stesso trigger) o elimina logicamente le regole.

Elenca e recupera: sfoglia le tue regole di automazione o recupera una regola specifica tramite il suo ID.

h. Abbonamenti:

Gestisci gli abbonamenti: recupera un elenco di tutte le risorse incluse in un abbonamento da piattaforme di terze parti e annulla un abbonamento immediatamente o alla fine del ciclo di fatturazione.

i. Webhook:

Gestisci i webhook: crea programmaticamente nuovi webhook per ricevere notifiche in tempo reale, recupera gli elenchi dei tuoi webhook esistenti e rimuovi i webhook non più necessari.

Note:

  • Per identificare e gestire facilmente i tuoi token, ognuno deve avere un nome univoco.
  • Un token può essere copiato solo immediatamente dopo la sua creazione. Se hai dimenticato di copiare il tuo token, eliminalo e creane uno nuovo.
  • Per motivi di sicurezza, ti invieremo una notifica via email ogni volta che viene creata una nuova chiave API pubblica nel tuo account systeme.io.
  • Puoi creare fino a 3 chiavi API per account.

Per saperne di più: documentazione API.