Il passaggio Effettua chiamata API consente a un bot conversazionale di usare una richiesta API REST per recuperare i dati da un sistema esterno, come Shopify o Salesforce.
In questa ricetta, creerai una risposta del bot che recupera i dati meteorologici per una località fornita da un utente finale. La risposta ottiene i dati dall’API OpenWeather. Puoi usare il flusso di risposte creato in questa ricetta come punto di partenza per creare le tue risposte basate su API.
- Attività 1: Verifica della configurazione
- Attività 2: Creazione di una connessione API
- Attività 3: Creazione di un campo ticket personalizzato
- Attività 4: Creazione di una risposta per il bot
- Attività 5: Test delle modifiche
Attività 1: Controllo della configurazione
Per completare questa ricetta, avrai bisogno di quanto segue:
- Un account Zendesk con un bot conversazionale pubblicato. Se lo desideri, puoi usare un ambiente di test sandbox per testare il bot prima di usarlo in produzione.
Per configurare un bot conversazionale su un canale di messaggistica web e mobile, consulta Utilizzo dei bot conversazionali per i canali web e mobile. Per informazioni sull’uso della messaggistica in un ambiente sandbox, consulta Uso della messaggistica nella sandbox.
- Una chiave API per un account OpenWeather . L’API usata in questa ricetta è disponibile con il piano gratuito di OpenWeather.
Per creare un account OpenWeather gratuito, consulta la pagina Crea nuovo account su openweathermap.org. Dopo aver effettuato l’accesso, puoi ottenere una chiave API nella pagina del tuo account OpenWeather.
Per attivare le chiavi API OpenWeather, devi verificare l’indirizzo email del tuo account. Dopo la verifica, l’attivazione delle chiavi API può richiedere fino a due ore. Per maggiori informazioni, consulta le domande frequenti su openweathermap.org.
Attività 2: Creazione di una connessione API
Per iniziare, crea una connessione API per memorizzare la chiave API OpenWeather. Il bot conversazionale può usare questa connessione per autenticare le chiamate all’API OpenWeather.
- Nel Centro amministrativo, fai clic su
App e integrazioni nella barra laterale, quindi seleziona Connessioni > Connessioni.
- Fai clic su Crea connessione.
- Seleziona il tipo di autenticazione con chiave API .
- Inserisci openweather_api_key come Nome connessione.
- Inserisci x-api-key come Nome intestazione.
- Inserisci la chiave API OpenWeather come Valore.
- Inserisci api.openweathermap.org come dominio consentito.
- Fai clic su Salva per creare la connessione.
Attività 3: Creazione di un campo ticket personalizzato
Quindi, crea un campo ticket personalizzato per acquisire la posizione fornita dall’utente finale.
- Nel Centro amministrativo, fai clic su
Oggetti e regole nella barra laterale, quindi seleziona Ticket > Campi.
- Fai clic su Aggiungi campo.
- Seleziona il tipo di campo Testo.
- Inserisci Località come Nome visualizzato.
- In Autorizzazioni, seleziona I clienti possono modificare.
- In Clienti, inserisci Località come Titolo mostrato ai clienti.
- Fai clic su Salva.
Se il tuo account usa un solo modulo ticket, il nuovo campo viene visualizzato automaticamente nel modulo ticket. Per rimuovere il campo, consulta Modifica dei moduli ticket.
Attività 4: Creazione di una risposta per il bot
Questa sezione spiega come creare la risposta, impostarne lo scopo e aggiungere i passaggi per la risposta in Creazione bot. Ciò comporta i seguenti passaggi:
- Passaggio 1: Creazione della risposta
- Passaggio 2: Impostazione dello scopo della risposta
- Passaggio 3: Aggiunta di un passaggio iniziale del messaggio
- Passaggio 4: Richiesta di una posizione all’utente finale
- Passaggio 5: Recupero dei dati meteorologici per la località
- Passaggio 6: Invio di un messaggio meteo all’utente finale
- Passaggio 7: Aggiunta di un messaggio di errore
- Passaggio 8: Pubblicazione del bot aggiornato
Passaggio 1: Creazione della risposta
Usa Creazione bot per creare una risposta per il bot conversazionale.
- Nel Centro amministrativo, fai clic su Canali
nella barra laterale e seleziona Bot e automazioni > Bot.
- Fai clic su Gestisci bot.
- Fai clic sul bot con cui vuoi lavorare.
- Nella scheda Risposte, fai clic su Crea risposta.
Passaggio 2: Impostazione dello scopo della risposta
Imposta lo scopo della risposta e le frasi di addestramento. Questi includono frasi e parole usate per attivare la risposta in una conversazione.
- Nella scheda Risposte della pagina di modifica del bot, fai clic su Crea risposta.
- Fai clic su Crea risposta personalizzata e seleziona Avanti.
- Inserisci Get weather come scopo della risposta.
- In Frasi di allenamento, inserisci Ottieni previsioni meteo e Ottieni temperatura attuale.
- Fai clic su Avanti.
La risposta si apre in Creazione bot, dove puoi creare la risposta.
Passaggio 3: Aggiunta di un passaggio iniziale del messaggio
Aggiungi un passaggio Invia messaggio per chiedere all’utente una posizione. Questo è il primo passaggio nel flusso della risposta.
- In Creazione bot, fai clic su Aggiungi passaggio.
- In Scegli passaggio, seleziona Invia messaggio.
- In Messaggio bot, inserisci il testo seguente:
What location would you like to get the weather for? Include the country code. For example: "Melbourne, AU" or "San Francisco, US"
Passaggio 4: Richiesta di una posizione all’utente finale
Dopo il messaggio iniziale, aggiungi un passaggio Chiedi dettagli per presentare un modulo di base all’utente finale. Il modulo include una casella di testo per il valore del campo Ticket ubicazione .
- In Creazione bot, fai clic sull’icona Aggiungi passaggio (
).
- In Scegli passaggio, seleziona Chiedi dettagli.
- Inserisci Get location come Nome.
- In Campi, digita e seleziona il campo Ticket ubicazione .
Passaggio 5: Recupero dei dati meteorologici per la località
Aggiungi un passaggio Effettua chiamata API per ottenere i dati meteorologici per la località dall’endpoint dei dati meteorologici correnti dell’API OpenWeather.
- In Creazione bot, fai clic su Aggiungi passaggio.
- In Scegli passaggio, seleziona Effettua chiamata API.
- Inserisci Get weather come Nome.
- In Dettagli API,inserisci
https://api.openweathermap.org/data/2.5/weather?units=metric&q=
come URL dell’endpoint. - Usa l’icona Aggiungi una variabile (
) per aggiungere la variabile del campo Posizione al valore dell’URL dell’endpoint .
Il valore finale dell’URL dell’endpoint dovrebbe essere simile al seguente:
- In Autenticazione, seleziona la connessione openweather_api .
- Per testare la richiesta API, fai clic su Effettua chiamata API.
- In Dati test, inserisci Melbourne, AU come Località.
- Fai clic su Effettua chiamata API.
- Salva le seguenti variabili usando i loro nomi predefiniti:
- principale > temp
- meteo > elemento 1> descrizione
Passaggio 6: Invio di un messaggio meteo all’utente finale
Dopo aver recuperato i dati meteorologici, usa il passaggio Invia messaggio per rispondere con un messaggio contenente i dati meteorologici.
- In Creazione bot, fai clic su Aggiungi passaggio nel ramo Ottieni chiamata API del passaggio meteo .
- In Scegli passaggio, seleziona Invia messaggio.
- In Messaggio bot, inserisci il testo seguente:
It's {{temp}}° C with {{description}} in
- Usa l’icona Aggiungi una variabile (
) per aggiungere la variabile del campo Ubicazione al valore del messaggio del bot . Quindi aggiungi un punto (.).
Il valore del messaggio del Bot finito dovrebbe essere simile al seguente:
Passaggio 7: Aggiunta di un messaggio di errore
La richiesta effettuata durante il passaggio Effettua chiamata API potrebbe non riuscire. Ad esempio, la richiesta potrebbe includere un'ubicazione che non esiste. Aggiungi un passaggio Invia messaggio al ramo Chiamata API non riuscita . Questo passaggio restituisce un messaggio se la chiamata API OpenWeather non riesce.
- In Creazione bot, fai clic su Aggiungi passaggio nel ramo Ottieni chiamata API del passaggio meteo non riuscita.
- In Scegli passaggio, seleziona Invia messaggio.
- In Messaggio bot, inserisci il testo seguente:
I'm sorry. I wasn't able to get weather data for
- Usa l’icona Aggiungi una variabile (
) per aggiungere la variabile del campo Ubicazione al valore del messaggio del bot . Quindi aggiungi un punto (.).
Il valore del messaggio del Bot finito dovrebbe essere simile al seguente:
Passaggio 8: Pubblicazione del bot aggiornato
Per inviare la risposta in tempo reale, pubblica il bot aggiornato.
- Fai clic su Fine nell’angolo in alto a destra di Creazione bot.
- Nella pagina del bot, fai clic su Pubblica bot.
- Fai clic su Pubblica.
Attività 5: Test delle modifiche in corso
Dopo aver pubblicato le modifiche, puoi provare la nuova risposta chiedendo "Come è il tempo?" in una conversazione con il bot aggiornato. Per ulteriori informazioni sul test dei bot conversazionali, consulta Verifica dell’esperienza di messaggistica dell’utente finale.
Avvertenza sulla traduzione: questo articolo è stato tradotto usando un software di traduzione automatizzata per fornire una comprensione di base del contenuto. È stato fatto tutto il possibile per fornire una traduzione accurata, tuttavia Zendesk non garantisce l'accuratezza della traduzione.
Per qualsiasi dubbio sull'accuratezza delle informazioni contenute nell'articolo tradotto, fai riferimento alla versione inglese dell'articolo come versione ufficiale.