Componente aggiuntivo WebHooks
Introduzione
Puoi utilizzare il componente aggiuntivo WebHooks per inviare dati dai tuoi moduli a qualsiasi pagina personalizzata o script che preferisci. Questa pagina può eseguire attività di integrazione per trasformare, analizzare, manipolare e inviare i dati inviati ovunque tu scelga.
Se stai sviluppando un'applicazione che deve essere aggiornata ogni volta che viene inviato un modulo, WebHooks fa al caso tuo. Il vantaggio dei WebHooks è che il passaggio dei dati è immediato ed è possibile passare tutti i dati del modulo inviato contemporaneamente.
Cos'è un WebHook?
Un WebHook è semplicemente una notifica push da iform4u a un altro server ogni volta che qualcuno invia i tuoi moduli.
Cosa puoi fare con un WebHook?
WebHooks semplifica l'integrazione di due sistemi. L'uso più comune di un WebHook è inserire lead nel tuo CRM. Ma ci sono anche molte altre cose che potresti fare.
Di che cosa hai bisogno?
La natura stessa di un WebHook presuppone che tu abbia una certa capacità di scrivere codice (o di corrompere un amico o un collega che lo fa). Devi avere un server in grado di accettare una richiesta POST (quella che otterresti dall'invio di un modulo) ed essere in grado di scrivere uno script che faccia qualcosa in risposta.
Nota: iform4u supporta l'integrazione di più WebHooks per modulo.
Creare un WebHook
Per creare un WebHook è necessario eseguire i seguenti passaggi:
- Vai a Gestione componenti aggiuntivi e fai clic su WebHooks .
- Fare clic sul pulsante Crea un webhook.
- Apparirà un modulo utilizzato per configurare il WebHook:
- Modulo : seleziona il modulo che invierà le notifiche.
- Chiave Handshake : questa è una chiave opzionale che scegli come meccanismo di autenticazione per prevenire lo spam sul tuo Web Hook. Questa chiave verrà inclusa come parametro del post quando i nostri server chiameranno la tua. Se usi questa chiave, dovresti confrontarla con la tua copia per verificare che l'invio sia legittimo.
- Url : l'URL in cui si trova lo script.
- Stato: Può essere:
- On : invia notifiche
- Spento : non invia notifiche
- Json: Può essere:
- On : invia i dati come stringa JSON
- Disattivato : invia i dati come stringa codificata URL
- Alias: Può essere:
- On : invia dati con alias campo come chiave parametro. Per esempio. Sostituisce "testo_0" con "nome".
- Off : invia i dati con l'ID campo come chiave parametro
- Fare clic su Crea.
Nota: selezionare più moduli per creare lo stesso WebHook per ogni modulo.
Disabilita/Abilita un WebHook
Per interrompere temporaneamente un webhook, puoi scegliere di disabilitarlo e abilitarlo in seguito. Per disabilitare un webhook del modulo, è necessario seguire questi passaggi:
- Vai a Gestione componenti aggiuntivi e fai clic su WebHooks .
- Fare clic sul pulsante Azioni del WebHook da disabilitare.
- Fare clic su Aggiorna.
- Cambia lo stato da On a Off o viceversa.
- Fare clic su Aggiorna.
Elimina un webhook
Per eliminare un WebHook è necessario eseguire i seguenti passaggi:
- Seleziona la casella di controllo del WebHook da eliminare.
- Fare clic su Azioni collettive.
- Fare clic su Elimina.
- Quindi verrà visualizzato un popup che ti chiede di confermare la tua decisione di eliminare il WebHook.
Il WebHooks Manager verrà ricaricato e il WebHook selezionato verrà eliminato.
Invia dati come JSON
Per inviare i dati del post come stringa JSON, devi seguire questi passaggi:
- Vai a Gestione componenti aggiuntivi e fai clic su WebHooks .
- Fare clic sul pulsante Azioni del WebHook da disabilitare.
- Fare clic su Aggiorna.
- Cambia il campo Json da On a Off o viceversa.
- Fare clic su Aggiorna.
Utilizzo WebHooks
Ora che sai cosa sono WebHooks e come usarli in iform4u, vediamo un esempio.
In questo tutorial invieremo notifiche da uno dei nostri moduli alla pagina: Beeceptor. Questa pagina cattura le nostre notifiche e le stampa sullo schermo.
Primi passi:
- Vai su https://beeceptor.com/
- Immettere un nome endpoint e
- Premere il pulsante Crea endpoint
- Copia l'URL dell'endpoint
Molto bene! Sappi di avere un URL che servirà per ricevere le notifiche inviate da iform4u.
Passaggi successivi:
- Vai su iform4u
- Vai a Gestione componenti aggiuntivi e installa WebHooks
- Ora fai clic su WebHooks .
- Fare clic sul pulsante Crea un webhook.
- Compila il modulo:
- Modulo: seleziona "Mailing List"
- URL: incolla l'URL dell'endpoint
- Chiave Handshake: per questo esempio: my_handshake_key
- Stato: attivato
- Fare clic su Crea
Passaggi finali: prova le tue notifiche
- Vai a Gestione moduli
- Fare clic sul modulo "Mailing List".
- Fai clic sul pulsante Pubblica e condividi (l'icona della freccia verde)
- Fare clic su Condividi collegamento modulo
- Seleziona la casella Senza e premi Vai!
- Compila il modulo Mailing List e invialo
Se la tua richiesta viene ricevuta, verrà visualizzato un messaggio di successo.
Ora, vai su Endpoint Url (e senza aggiornare la pagina) vedrai che la notifica contiene:
- ID modulo
- Nome del modulo
- IP utente
- Dati di invio
- Tasto stretta di mano
E questo è tutto! Hai inviato la tua prima notifica a un altro server. Congratulazioni!
Salvataggio degli invii di moduli in un database esterno
Ora che sappiamo come esportare gli invii di moduli in tempo reale su un'applicazione esterna, vedremo come archiviarli in un database.
Se disponi di un sito web, puoi eseguire i seguenti passaggi e archiviare gli invii dei moduli del nostro modulo demo nel tuo database, devi solo modificare l'URL del webhook.
Nel tuo sito web:
1.- Creare un database : ' test '. Puoi farlo con il tuo software preferito, come phpMyAdmin o anche utilizzando il seguente MySQL :
CREATE DATABASE 'test';
2.- Creare una tabella di database : ' abbonati ', con 4 campi: id, nome, email indirizzo ip_ . È possibile eseguire la seguente query MySQL
CREATE TABLE `test`.`subscribers` (
`id` INT(11) NOT NULL AUTO_INCREMENT ,
`name` VARCHAR(255) NOT NULL ,
`email` VARCHAR(255) NOT NULL ,
`ip_address` VARCHAR(255) NOT NULL ,
PRIMARY KEY (`id`)) ENGINE = InnoDB;
3.- Imposta le informazioni nel tuo database : 'test'. IlsaveToDB.php
file consente di configurare i seguenti parametri:
define('DB_SERVER', "localhost");
define('DB_USER', "root");
define('DB_PASSWORD', "");
define('DB_DATABASE', "test");
define('DB_DRIVER', "mysql");
4.- Carica il file @app/custom/saveToDB.php sul tuo server.
