La maggior parte delle persone compila i moduli in un browser. Ma gli sviluppatori inseriscono i moduli in applicazioni personalizzate, app mobili, sistemi integrati e strumenti interni. Questi moduli non usano il creatore di moduli con trascinamento. Usano le API per inviare i dati direttamente alla tua piattaforma di moduli.
Questo articolo spiega come funzionano le API dei moduli, quando ti servono e che cosa cercare in una piattaforma di moduli che offre un accesso API solido.
Che cos'è un'API per i moduli e perché la usano gli sviluppatori
Un'API per i moduli è un modo per gli sviluppatori di inviare i dati di un modulo in modo programmatico, invece che da un modulo nel browser. Invece di qualcuno che clicca su "invia" in un modulo web, uno sviluppatore scrive codice che manda i dati direttamente al sistema dei moduli.
Quando lo faresti?
Creare un'applicazione personalizzata: stai creando la tua app e vuoi raccogliere i dati dei moduli usando il tuo strumento per moduli come backend. Il tuo codice chiama l'API dei moduli per inviare.
Invio di moduli da un'app mobile: hai un'app mobile con un modulo. Quando gli utenti inviano, il codice dell'app chiama l'API dei moduli.
Integrare dati da più fonti: raccogli dati da vari sistemi e vuoi che finiscano tutti in un'unica piattaforma di moduli. Il tuo codice di integrazione usa l'API dei moduli.
Operazioni in blocco: hai migliaia di record da importare. Invece di inserirli a mano, il tuo codice usa l'API dei moduli per inviarli in modo programmatico.
Come funzionano le API dei moduli (senza dover capire il codice)
Un'API per i moduli funziona così: la tua applicazione ha dei dati. Vuole inviarli alla piattaforma di moduli. Fa una chiamata API (pensala come un messaggio) che dice "ecco dei dati, per favore salvali". La piattaforma li riceve, li convalida e li salva proprio come farebbe se qualcuno avesse compilato un modulo web e cliccato su invia.
La piattaforma di moduli restituisce una risposta che conferma che l'invio è stato ricevuto e salvato.
Dal punto di vista della piattaforma, i dati di un invio via API sono identici a quelli di un invio da modulo web. Vengono trattati allo stesso modo.
Autenticazione e sicurezza dell'API
Quando il tuo codice chiama un'API per i moduli, deve dimostrare di essere autorizzato. Lo fa con l'autenticazione, di solito una chiave API.
Una chiave API è come una password per la tua applicazione. La tieni segreta. Quando il tuo codice vuole inviare dati, include la chiave API. La piattaforma controlla la chiave e dice "sì, questa applicazione è autorizzata".
Non pubblicare mai la tua chiave API in codice pubblico e non condividerla. Se qualcuno la ottiene, può inviare dati dei moduli a tuo nome (e può essere un problema se usi gli invii dei moduli per decisioni critiche per l'azienda).
Limiti di frequenza: quante chiamate API sono consentite
La maggior parte delle piattaforme di moduli limita il numero di chiamate API che puoi fare. Serve a prevenire gli abusi e a proteggere il sistema.
Un limite tipico può essere "1.000 chiamate API all'ora per chiave API". Se la tua applicazione fa più chiamate del limite, quelle successive vengono rifiutate finché l'ora non si azzera.
Quando scegli una piattaforma di moduli, controlla i limiti di frequenza delle API. Se devi fare 10.000 invii all'ora, un limite di 1.000 chiamate all'ora non va bene. Chiedi alla piattaforma limiti più alti o opzioni di scalabilità.
Risposte dell'API e gestione degli errori
Quando il tuo codice chiama l'API dei moduli, riceve una risposta. Questa risposta ti dice se l'invio è riuscito o fallito.
Risposta di successo: HTTP 200 o 201. L'invio è stato ricevuto e salvato. Il tuo codice può proseguire.
Risposta di errore: HTTP 400, 401, 500 e così via. Qualcosa è andato storto. Il tuo codice deve gestire l'errore (riprovare, registrarlo, avvisare qualcuno).
I buoni messaggi di errore delle API ti dicono che cosa è andato storto. "Campo obbligatorio mancante: email" è utile. "Errore" senza dettagli no.
Invii in blocco via API
A volte hai più invii da fare insieme. Alcune API supportano le operazioni in blocco: invii 100 invii in una sola chiamata API invece di fare 100 chiamate separate.
Gli invii in blocco sono più efficienti. Riducono il numero di chiamate API e si completano più in fretta.
Controlla se l'API della tua piattaforma di moduli supporta gli invii in blocco. Se devi importare grandi volumi di dati, questa funzione conta.
Notifiche webhook dal punto di vista dell'API
Quando i dati arrivano via API, potresti volere notifiche o azioni successive. Alcune piattaforme di moduli inviano notifiche webhook anche per gli invii via API, proprio come fanno per gli invii dei moduli web.
Questo significa che, se il tuo codice invia via API, i sistemi a valle (CRM, email e così via) vengono comunque avvisati in automatico.
Documentazione dell'API ed esperienza degli sviluppatori
Una buona API per i moduli ha una documentazione eccellente. Spiega come autenticarsi, quale endpoint chiamare, quale formato di dati usare, quali errori puoi ricevere e include esempi di codice.
Una documentazione API scadente rende la vita dello sviluppatore un incubo. Se stai scegliendo una piattaforma di moduli e ti serve l'accesso API, leggi prima la loro documentazione. È chiara? Ci sono esempi? Riesci a capirla?
Quando usare l'API e quando i moduli web
Usa un modulo web quando: vuoi che i visitatori compilino un modulo nel browser. Non ti serve codice. L'interfaccia a trascinamento del creatore di moduli basta.
Usa un'API quando: sei uno sviluppatore e crei un'applicazione personalizzata. Devi inviare dati in modo programmatico. Stai integrando più fonti di dati. Devi personalizzare tutta l'esperienza di invio.
Spesso si usano entrambi. Un sito ha moduli web per i visitatori. La tua applicazione interna usa l'API per gli invii programmatici.
Come WEMASY supporta le API dei moduli
WEMASY offre un'API REST che permette agli sviluppatori di inviare i dati dei moduli in modo programmatico. Ti autentichi con una chiave API, invii i dati all'endpoint e ricevi la conferma. Gli invii via API sono trattati in modo identico a quelli dei moduli web. Attivano le automazioni, si sincronizzano con i sistemi integrati e compaiono nella tua dashboard WEMASY. Limiti di frequenza e invii in blocco sono disponibili in base al tuo piano. Consulta la documentazione API nel tuo account WEMASY oppure la pagina prezzi per i dettagli sull'accesso API.