Apigee Integration con un trigger API

Questa guida rapida mostra come creare un'integrazione di esempio in Apigee Integration. I passaggi seguenti spiegano come configurare l'attivatore, le attività, gli spigoli, le variabili e le mappature dei dati necessari per eseguire un'integrazione completa.

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

Creazione di una nuova integrazione

Per creare una nuova integrazione:

  1. Nell'UI 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 delle integrazioni.

Aggiungi e configura un trigger API

Gli attivatori sono necessari per avviare la sequenza di attività che compongono 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 dell'integrazione, fai clic su Trigger per visualizzare un elenco di trigger disponibili.
  2. Fai clic sull'elemento trigger 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. Apigee Integration compila automaticamente i trigger Etichetta, Nome trigger e ID trigger. L'ID trigger è generato automaticamente e non può essere modificato. Tuttavia, puoi modificare il valore delle proprietà Etichetta e Nome trigger.

    Le modifiche alle proprietà vengono salvate automaticamente.

Aggiungi e configura attività

Un'attività è un insieme eseguibile di passaggi che possono prendere 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à Chiama endpoint REST, Mappatura dei dati e Invia email. I dettagli della configurazione per ogni attività sono descritti nei passaggi riportati di seguito.

Configura l'attività Chiama endpoint REST

Per configurare l'attività Chiama endpoint REST, segui questi passaggi:

  1. Seleziona Attività per visualizzare un elenco delle attività disponibili.
  2. Fai clic e posiziona l'elemento Chiama endpoint REST nell'editor di integrazione.
  3. Aggiungi una connessione perimetrale dall'elemento trigger API all'elemento Chiama endpoint REST passando il mouse sopra un punto di controllo sull'elemento trigger API, quindi facendo clic su una linea e trascinandola fino a un punto di controllo sull'elemento dell'attività Chiama endpoint REST. 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 trigger) a un altro. Per ulteriori informazioni sui bordi, consulta la sezione Bordi.

  4. Fai clic sull'elemento Call REST Endpoint (Chiama endpoint REST) 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, vedi 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 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 relative a un articolo denominato Albero in un determinato mese.
      • Metodo HTTP: seleziona GET dall'elenco a discesa.
    • Task Output: qui Apigee Integration compila tre variabili per contenere l'output dei dati di risposta per la chiamata all'endpoint REST:
      • responseHeader(Call REST Endpoint): questa variabile contiene i dati dell'intestazione della risposta associati all'attività Call REST Endpoint. I dati variabili sono di tipo String (STR).
      • responseBody(Call REST Endpoint): questa variabile contiene i dati del corpo della risposta associati all'attività Call REST Endpoint. I dati variabili sono di tipo String (STR).
      • responseStatus(Call REST Endpoint): questa variabile contiene i dati sullo stato della risposta associati all'attività Chiama endpoint REST. I dati variabili sono di tipo String (STR).
    • Visualizza i dettagli di ogni variabile facendo clic sul nome della variabile nel riquadro di configurazione dell'attività. Per questa guida rapida, lascia i valori predefiniti per ciascuna di queste variabili.
    • I restanti campi 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 le esecuzioni asincrone: None

    Le modifiche alle proprietà vengono salvate automaticamente.

Aggiungere e configurare l'attività 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 Mappatura dei dati e posizionalo nell'editor dell'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 fino a un punto di controllo sull'elemento dell'attività Mappatura dei dati. Il perimetro indica il flusso di controllo dall'attività Chiama endpoint REST all'attività Mappatura dei dati.
  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 alle variabili di output desiderate utilizzando le funzioni di trasformazione disponibili. L'output è quindi disponibile come variabile per qualsiasi altra attività o trigger di integrazione. Per maggiori dettagli sul trasferimento dei dati come variabili, consulta Utilizzare le variabili nell'integrazione di Apigee.

    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 Input.
    2. Fai clic su + (Aggiungi una funzione) nel chip della variabile responseBody per visualizzare l'elenco a discesa delle funzioni disponibili.
    3. Puoi applicare varie funzioni per trasformare i dati nella variabile di input.

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

      • Seleziona TO_JSON() per convertire la stringa responseBody in JSON.
      • Fai clic su + (Aggiungi una funzione) nel chip della 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 estrarrà una proprietà dal payload JSON. Passa la proprietà items come parametro per questa funzione. Verrà restituito un elenco SOLO dei nomi dei prodotti, senza altre informazioni sul prodotto. La funzione dovrebbe essere come segue: 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)

      • Per 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 che contenga il valore dei dati trasformati. Completa i seguenti campi:
      • Nome: inserisci JSONList.
      • Tipo di dati: JSON
      • Seleziona la casella di controllo Utilizza 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 a sinistra dell'editor di mappatura dei dati.
    5. Chiudi l'editor di mappatura dei dati al termine della mappatura. Eventuali modifiche verranno salvate automaticamente.

Aggiungi e configura l'attività Invia email

Per configurare l'attività Invia email:

  1. Seleziona Tasks nell'editor dell'integrazione per visualizzare l'elenco delle attività disponibili.
  2. Fai clic sull'elemento Invia email e posizionalo nell'editor dell'integrazione.
  3. Aggiungi una connessione perimetrale dall'elemento Mappatura dei dati all'elemento Invia email passando il mouse sopra un punto di controllo sull'elemento Mappatura dei dati, quindi facendo clic su una linea e trascinandola fino a un punto di controllo nell'elemento dell'attività Invia email. Il bordo indica il flusso di controllo dall'attività Mappatura dei dati all'attività Invia email.
  4. Fai clic sull'elemento Invia email nel designer per aprire il riquadro di configurazione dell'attività. Imposta le seguenti proprietà:
    • A destinatari: inserisci il tuo indirizzo email. Dovrai utilizzare questa 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 altre 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 trigger) a un altro. Per ulteriori informazioni sui bordi, consulta la sezione Bordi.

La connessione completata dovrebbe essere visualizzata come mostrato nella figura seguente:

immagine che mostra il flusso di avvio rapido immagine che mostra il flusso di avvio rapido

Testare l'integrazione

Per testare la nuova integrazione:

  1. Fai clic su Test (Test) nella barra degli strumenti dell'editor delle integrazioni.

    Viene visualizzato il riquadro Testa integrazione.

  2. Fai clic su Testa integrazione.

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

Al termine, 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 integrazioni.
  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, oltre allo stato dell'attività e ai payload variabili.