Apigee Integration con un trigger API

Questa guida rapida mostra come creare un'integrazione di esempio in Apigee Integration. I passaggi seguenti descrivono come configurare il trigger, le attività, i bordi, le variabili e le mappature dei dati necessari per eseguire un'integrazione completa.

In questa guida rapida, recupererai il numero di visualizzazioni di pagina da un'API pubblica, trasformerai i dati in un formato utilizzabile e invierai l'elenco risultante via email, il tutto dall'interno del designer dell'integrazione.

Creazione di una nuova integrazione

Per creare una nuova integrazione, segui questi passaggi:

  1. Nell'interfaccia utente di Apigee, seleziona la tua organizzazione Apigee.
  2. Fai clic su Sviluppa > Integrazioni.
  3. Fai clic su Create Integration (Crea integrazione).
  4. Inserisci un nome e una descrizione nella finestra di dialogo Crea integrazione.

    Per questa guida rapida, inserisci il nome my-test-integration e la descrizione Integration for quickstart.

  5. Seleziona una regione per l'integrazione.
  6. Fai clic su Crea per aprire l'editor di integrazione.

Aggiungi e configura un trigger API

Gli attivatori sono necessari per avviare la sequenza di attività che costituiscono un'integrazione. Qualsiasi trigger disponibile può essere utilizzato per avviare un'integrazione. Per questa guida rapida, utilizza il trigger API.

Per configurare il trigger API:

  1. Nell'editor di integrazione, fai clic su Attivatori per visualizzare un elenco degli attivatori disponibili.
  2. Fai clic sull'elemento attivatore API e posizionalo nell'editor di integrazione.
  3. Fai clic sull'elemento Trigger API nel designer per aprire il riquadro di configurazione del trigger.
  4. L'Apigee Integration completa automaticamente i campi Etichetta, Nome trigger e ID trigger. L'ID trigger è generato automaticamente e non puoi modificare il valore. Tuttavia, puoi modificare il valore delle proprietà Etichetta e Nome trigger.

    Le modifiche alle proprietà vengono salvate automaticamente.

Aggiungi e configura le attività

Un'attività è un insieme eseguibile di passaggi che possono utilizzare le variabili come input e generare variabili come output. Come per i trigger, qualsiasi attività disponibile può essere utilizzata in un'integrazione. Questa guida rapida utilizza le attività Chiamata endpoint REST, Mappatura dati e Invia email. I dettagli di configurazione di ogni attività sono descritti nei passaggi seguenti.

Configura l'attività di chiamata endpoint REST

Per configurare l'attività Chiama endpoint REST:

  1. Seleziona Attività per visualizzare un elenco delle attività disponibili.
  2. Fai clic sull'elemento Call REST Endpoint e posizionalo nell'editor di integrazione.
  3. Aggiungi una connessione perimetrale dall'elemento attivatore API all'elemento Endpoint REST di chiamata passando il mouse sopra un punto di controllo sull'elemento Trigger API, quindi facendo clic e trascinando una linea in un punto di controllo sull'elemento dell'attività Endpoint REST di chiamata. Il perimetro indica il flusso di controllo dal trigger API all'attività Chiama endpoint REST.

    Un perimetro è una connessione tra due elementi qualsiasi in un'integrazione. La connessione indica la direzione del flusso di controllo da un elemento (attività o attivatore) a un altro. Per ulteriori informazioni sui bordi, vedi Bordi.

  4. Fai clic sull'elemento Endpoint REST di chiamata nel designer per aprire il riquadro di configurazione delle attività. Imposta le seguenti proprietà:
    • Etichetta:inserisci un nome personalizzato per questa attività. Ad esempio, inserisci Call REST Endpoint Task.
    • Autenticazione:per questa guida rapida, non è richiesto un profilo di autenticazione. Per maggiori informazioni sull'utilizzo dei profili di autenticazione per altri casi d'uso, consulta Creare profili di autenticazione in Apigee Integration.
    • Input attività:inserisci i dettagli per chiamare l'endpoint REST. Le informazioni inserite qui vengono utilizzate come input per l'attività Chiama endpoint REST. Inserisci le seguenti informazioni:
      • URL di base dell'endpoint: inserisci https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031. Questa API pubblica di wikimedia.org restituisce il numero di visualizzazioni di pagina per un articolo denominato Tree in un determinato mese.
      • Metodo HTTP:seleziona GET dall'elenco a discesa.
    • Output attività: qui Apigee Integration compila tre variabili per contenere l'output dei dati di risposta della chiamata dell'endpoint REST:
      • responseHeader(Call REST Endpoint): questa variabile contiene i dati dell'intestazione della risposta associati all'attività Chiama endpoint REST. I dati della variabile sono di tipo String (STR).
      • responseBody(Call REST Endpoint): questa variabile contiene i dati del corpo della risposta associati all'attività Chiama endpoint REST. I dati della variabile sono di tipo String (STR).
      • responseStatus(Call Endpoint REST): questa variabile contiene i dati sullo stato della risposta associati all'attività Chiamata endpoint REST. I dati della variabile sono di tipo String (STR).
    • Visualizza i dettagli di ogni variabile facendo clic sul suo nome nel riquadro di configurazione delle attività. Per questa guida rapida, lascia i valori predefiniti per ciascuna di queste variabili.
    • I campi rimanenti devono contenere i seguenti valori predefiniti:
      • Segui i reindirizzamenti: True
      • L'attività non dovrebbe riuscire in caso di errore HTTP: False
      • Strategia di gestione degli errori
        • Strategia per le esecuzioni sincrone: None
        • Strategia per esecuzioni asincrone: None

    Le modifiche alle proprietà vengono salvate automaticamente.

Aggiungi e configura l'attività di mappatura dei dati

Per configurare l'attività Mappatura dei dati:

  1. Seleziona Attività per visualizzare un elenco delle attività disponibili.
  2. Fai clic sull'elemento Data Mapping e posizionalo nell'editor di integrazione.
  3. Aggiungi una connessione perimetrale dall'elemento Call REST Endpoint all'elemento Data Mapping passando il mouse sopra un punto di controllo sull'elemento Call REST Endpoint, quindi facendo clic e trascinando una linea in un punto di controllo sull'elemento attività Data Mapping. Il perimetro indica il flusso di controllo dall'attività Call endpoint REST all'attività Data Mapping.
  4. Fai clic sull'attività Mappatura dei dati nel designer per aprire il riquadro di configurazione dell'attività.
  5. Fai clic su Apri editor di mappatura dei dati.

    L'Editor di mappatura dei dati consente di mappare le variabili di input a quelle di output desiderate, utilizzando le funzioni di trasformazione disponibili. L'output è quindi disponibile come variabile per qualsiasi altro trigger o attività di integrazione. Per maggiori dettagli sul passaggio dei dati come variabili, consulta Utilizzare le variabili in Apigee Integration.

    Per questa guida rapida, crea una mappatura utilizzando responseBody(Call REST Endpoint) come input:

    1. Trascina la variabile responseBody dal riquadro Variabili alla prima riga Immissione.
    2. Fai clic su + (Aggiungi una funzione) nel chip di variabile responseBody per visualizzare l'elenco a discesa delle funzioni disponibili.
    3. Puoi applicare una serie di funzioni per trasformare i dati nella variabile di input.

      In questo caso, puoi convertire il payload in JSON e quindi eseguire l'iterazione nell'array di risposta per ottenere l'elenco dei nomi di prodotto richiesti per le notifiche via email.

      • Seleziona TO_JSON() per convertire la stringa responseBody in JSON.
      • Fai clic su + (Aggiungi una funzione) nel chip di variabile responseBody per selezionare e concatenare la funzione GET_PROPERTY().
      • Per aggiungere il parametro di input per GET_PROPERTY(), fai clic su Variabile o valore e in Valore inserisci items.

        Questa funzione estrae una proprietà dal payload JSON. Passa la proprietà items come parametro per questa funzione. Verrà restituito un elenco contenente SOLTANTO i nomi dei prodotti, senza altre informazioni sui prodotti. La funzione dovrebbe essere come segue: 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)
      • Se devi rimuovere o eliminare una funzione, fai clic sul simbolo -.
    4. Fai clic sul primo campo della colonna Output per creare una nuova variabile di output contenente il valore dei dati trasformati. Completa i seguenti campi:
      • Nome:inserisci JSONList.
      • Tipo di dati: JSON
      • Seleziona la casella di controllo Usa come output di integrazione.
      • Fai clic su Crea per creare la variabile e chiudere il riquadro. La nuova variabile JSONList verrà visualizzata nell'elenco Variabili sul lato sinistro dell'editor di mappatura dei dati.
    5. Chiudi Data Mapping Editor al termine della mappatura. Le modifiche verranno salvate automaticamente.

Aggiungi e configura l'attività Invia email

Per configurare l'attività Invia email:

  1. Seleziona Tasks nell'editor di integrazione per visualizzare l'elenco delle attività disponibili.
  2. Fai clic sull'elemento Send Email e posizionalo nell'editor di integrazione.
  3. Aggiungi una connessione perimetrale dall'elemento Data Mapping all'elemento Send Email passando il mouse sopra un punto di controllo sull'elemento Data Mapping, quindi fai clic e trascina una linea in un punto di controllo sull'elemento attività Send Email. Il bordo indica il flusso di controllo dall'attività Mappatura dei dati all'attività Invia email.
  4. Fai clic sull'elemento Send Email sul designer per aprire il riquadro di configurazione dell'attività. Imposta le seguenti proprietà:
    • Ai destinatari: inserisci il tuo indirizzo email. Utilizzerai questo indirizzo email per confermare il corretto completamento dell'integrazione.
    • Oggetto: Inserisci Email from Apigee Integration.
    • Corpo in testo normale: seleziona la variabile JSONList creata in precedenza nell'attività Mappatura dei dati.
    • Le restanti opzioni possono essere lasciate nella configurazione predefinita.

    Le modifiche alle proprietà vengono salvate automaticamente.

Verifica le connessioni perimetrali richieste

Verifica di aver aggiunto una connessione perimetrale tra gli elementi nell'integrazione. La connessione indica la direzione del flusso di controllo da un elemento (attività o attivatore) a un altro. Per ulteriori informazioni sui bordi, vedi Bordi.

La connessione completata dovrebbe essere visualizzata come nell'immagine seguente:

immagine che mostra il flusso della guida rapida immagine che mostra il flusso della guida rapida

Testare l'integrazione

Per testare la nuova integrazione:

  1. Fai clic su Test nella barra degli strumenti dell'editor di integrazione.

    Viene visualizzata la finestra di dialogo Testa integrazione.

  2. Fai clic su Test Integration (Verifica l'integrazione).

Per saperne di più sui test, consulta Testare e pubblicare le integrazioni.

Una volta completata l'integrazione, l'integrazione invia un'email con i valori JSON all'indirizzo email specificato nell'attività Invia email. Conferma la ricezione dell'email nel tuo client di posta.

L'email inviata dall'integrazione deve contenere un corpo simile al seguente: 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

Oltre a verificare i contenuti dell'email, puoi esaminare i log per visualizzare lo stato e il payload di una determinata integrazione. Per visualizzare i log:

  1. Fai clic su Log nella barra degli strumenti dell'editor di integrazione.
  2. Nella pagina Log di esecuzione puoi visualizzare i dettagli di ogni tentativo di eseguire un'integrazione. Ogni voce include i dettagli del tentativo di esecuzione, tra cui:
    • Nome integrazione
    • ID esecuzione
    • Stato
    • Ora di inizio
    • Durata
    • Versione integrazione
    • ID attivatore
  3. Fai clic sulla freccia di espansione (>) accanto all'integrazione eseguita per visualizzare un elenco espanso di attività e variabili nell'integrazione, insieme allo stato delle attività e ai payload variabili.