Richiesta web - BETA

Utilizzare la fase di richiesta web per recuperare informazioni da utilizzare all'interno di un bot o per guidare le modifiche in un sistema esterno. La fase viene eseguita da Ivanti Neurons Platform e viene effettuata una volta per ogni dispositivo che passa attraverso la fase. Può interagire con API REST di terze parti ed è supportato da API non autenticate e autenticate.

Come configurare la fase Richiesta web

1. Nella pagina Crea bot, aggiungere una fase Richiesta web a un bot e aprire le Impostazioni della fase.
2. Dal menu a discesa Seleziona credenziale, selezionare la credenziale se la richiesta web richiede l'autenticazione. Se è necessario creare nuove credenziali, fare clic su Aggiungi credenziali per aprire l'Archivio credenziali. Attualmente sono supportate le autenticazioni API di base e API Key. Se non sono richieste credenziali, lasciare l'impostazione predefinita Nessuna autenticazione.
3. Alla voce Intestazioni impostare Mostra intestazioni autogenerate su Attivato se si desidera visualizzare le intestazioni autogenerate. Le intestazioni sono in linea con i requisiti dell'API di destinazione; per ulteriori dettagli, consultare la documentazione di terze parti.
   • Chiave: inserire la chiave di intestazione per la richiesta web.
   • Valore: inserire il valore di intestazione per la richiesta web.
4. Selezionare il Metodo. È il metodo HTTP che verrà utilizzato per accedere all'API di destinazione. I metodi supportati sono: GET, POST, PUT, PATCH e DELETE.
5. Inserire l'indirizzo API. L'indirizzo deve essere accessibile a Internet.
   Se si passano valori da un'altra fase o da un input del bot e l'API di destinazione accetta un payload JSON, fare clic su Modifica body JSON per aprire l'editor Json. Selezionare i valori che si desidera includere (la fase Richiesta web deve essere collegata a qualsiasi fase precedente per trasferire le informazioni).
   
6. Scegliere la Modalità di output appropriata per riflettere la risposta dell'API. Se si è selezionato un metodo HTTP di GET, il più comune sarà JSON.
7. Fare clic su Testa e ottieni risposta per effettuare una chiamata immediata all'API.
   Se il corpo JSON conteneva variabili di fasi precedenti, verrà richiesto di inserire dati di esempio.
8. L'esempio di risposta è popolato dall'azione di risposta Testa e ottieni.
   Una volta verificata la risposta, si può determinare se i risultati sono singoli (campi unici per endpoint) o un array (valori multipli per un dato campo per endpoint).
9. Se i risultati sono un array, è necessario attivare Array di mapping.
   Quando la fase è in modalità Array di mapping, visualizzerà il badge "multiplo", il che significa che per utilizzare i risultati nella maggior parte delle altre fasi è necessario utilizzare un blocco "For-each" per eseguire il contenuto di ciascun risultato.
   • Inserire il Percorso all'array.
10. Una volta che il selettore Array di mapping è Attivato, completare i seguenti attributi Mappa di campo:
    • Percorso all'interno dell'elemento array: il percorso dell'oggetto nella risposta JSON. Questo può essere solo il nome, ma se l'oggetto è nidificato il percorso deve essere indicato con la sintassi a punti, ad es. level1.level2.myfield
      Esempio singolare:
      {"configuration": {startup_events": {"updates": "some value"}}}
      Il percorso degli aggiornamenti sarebbe: configuration.startup_events.updates
      Esempio di array:
      {"users": [{display_info": {"name": "John"}}]}
      Il percorso all'array sarebbe: utenti
      Il percorso all'interno dell'array sarebbe: display_info.name
    • Tipo: deve corrispondere al formato del valore letto, in modo da poter applicare i filtri/comportamenti corretti nelle fasi successive.
    • Etichetta mappata: è il nome descrittivo per il campo che apparirà nel token picker e nei filtri nelle fasi successive.

Una volta selezionati gli attributi dell'Array di mapping, fare clic su Test mapping per verificare i mapping rispetto alla Risposta di esempio, in modo da confermare che i mapping siano corretti.