Stai
visualizzando la documentazione di Apigee X.
Visualizza la documentazione di Apigee Edge.
Questo tutorial ti mostra come utilizzare Apigee Integration e connettori per creare un'integrazione di esempio che attivi la pubblicazione di un messaggio Cloud Pub/Sub. Il tutorial presuppone che tu conosca le funzionalità di integrazione di Apigee.
In questo esempio, la chiamata di un endpoint API attiva la pubblicazione di un messaggio in un argomento Cloud Pub/Sub. I passaggi seguenti descrivono come configurare il trigger dell'API e la connessione Cloud Pub/Sub necessaria per eseguire correttamente l'integrazione.
Prima di iniziare
Prima di iniziare questo tutorial, conferma le credenziali di accesso e i dettagli dell'organizzazione di Google Cloud. Queste informazioni sono necessarie per accedere all'interfaccia utente dei connettori. Le credenziali Apigee sono necessarie per accedere all'attività di connettore all'interno del designer di integrazione Apigee. Di seguito sono descritti ulteriori passaggi preliminari:
-
Prima di creare una connessione per la prima volta, completa i seguenti passaggi:
- Crea una nuova istanza di Apigee. È possibile eseguire il provisioning delle nuove istanze Apigee tramite la UI di provisioning.
Per un elenco delle aree geografiche che supportano i connettori, consulta la sezione Aree geografiche supportate per i connettori.
- Verifica che le funzionalità di integrazione e connettori di Apigee siano autorizzate al tuo abbonamento Apigee.
- Abilita le funzionalità Apigee Integration e Connectors utilizzando il seguente comando:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H \ "content-type:application/json" \ "https://apigee.googleapis.com/v1/organizations/PROJECT_ID:setAddons" -XPOST \ -d '{"addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig": {"enabled": true}}}'
- Crea una nuova istanza di Apigee. È possibile eseguire il provisioning delle nuove istanze Apigee tramite la UI di provisioning.
- Prima di creare una connessione Cloud Pub/Sub da utilizzare nella tua integrazione:
- Crea un argomento Cloud Pub/Sub e aggiungi una sottoscrizione, come descritto nella guida rapida di Cloud Pub/Sub: utilizzo della console.
- Concedi l'autorizzazione per pubblicare nell'argomento Cloud Pub/Sub. Ad esempio, puoi utilizzare il ruolo
roles/pubsub.publisher
per pubblicare argomenti. Per saperne di più sui ruoli Cloud Pub/Sub, vedi Controllo accesso. - Genera una chiave per l'account di servizio. Il file della chiave JSON viene utilizzato in un passaggio successivo per configurare la connessione Cloud Pub/Sub.
- In Cloud Console, vai alla pagina Apigee > Connectors e seleziona o crea un progetto Cloud.
- Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
- Configura la connessione:
- Nella sezione Create Connection, completa quanto segue:
- Connettore: seleziona il tipo di connettore dall'elenco a discesa dei tipi di connettore disponibili. Per questo esempio, seleziona gcp > pubsub.
- Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
- Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.
I nomi delle connessioni devono soddisfare i seguenti criteri:
- I nomi delle connessioni possono contenere lettere, numeri o trattini.
- Le lettere devono essere maiuscole.
- I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
- I nomi delle connessioni non possono superare i 63 caratteri.
- Facoltativamente, aggiungi una descrizione dell'istanza di connessione.
- ID progetto: inserisci il progetto Google Cloud in cui si trova l'istanza Cloud Pub/Sub.
- ID argomento: inserisci il nome dell'argomento Cloud Pub/Sub in cui deve essere pubblicato il messaggio.
- Se necessario, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
- Fai clic su AVANTI.
- Posizione. Scegli la posizione per la connessione.
- Seleziona una località in cui Apigee è disponibile dall'elenco a discesa Regione.
- Fai clic su AVANTI.
- Autenticazione: fornisci le credenziali di autenticazione per l'istanza di connessione, se necessario. La connessione Cloud Pub/Sub non richiede la configurazione dell'autenticazione.
- Fai clic su AVANTI.
- Verifica: esamina i dettagli della configurazione delle connessioni. In questa sezione vengono visualizzati i dettagli della connessione e dell'autenticazione della nuova connessione.
- Nella sezione Create Connection, completa quanto segue:
- Fai clic su Crea.
- Vai alla UI di Apigee e accedi allo stesso progetto in cui è stata creata la connessione.
- Fai clic su Develop > Integrations (Sviluppa).
- Fai clic su CREA NUOVO.
- Inserisci un nome e una descrizione nella finestra di dialogo Create Integration (Crea integrazione).
- Fai clic su Crea per aprire il designer di integrazione.
- Nel designer di integrazione, fai clic su + Aggiungi un'attività/un attivatore per visualizzare la finestra di dialogo per la selezione dell'attività e dell'attivatore.
- Fai clic su Attivatori per visualizzare gli attivatori disponibili.
- Trascina l'elemento API Trigger nel designer.
- Vai alla UI di Apigee ed esegui l'accesso.
- Seleziona la tua organizzazione utilizzando il menu a discesa nell'angolo in alto a sinistra dell'interfaccia utente.
- Fai clic su Develop > Integrations (Sviluppa).
- Cerca o seleziona l'integrazione da modificare dall'elenco Integrazioni e fai clic per aprire il designer dell'integrazione.
- Fai clic su +Aggiungi un'attività/trigger > Tasks per visualizzare l'elenco delle attività disponibili.
- Trascina l'elemento attività Connettori nel designer di integrazione.
- Fai clic sull'elemento attività Connettori nella designer per visualizzare il riquadro di configurazione dell'attività Connettori.
- (Facoltativo) Fai clic sulla per modificare il nome dell'attività. In questo modo puoi cambiare il nome dell'attività da Connettori generici a un nome significativo per l'integrazione.
- Nella scheda Configurazione, nella sezione Configurazione, fai clic sul pulsante Configura attività per aprire il riquadro Configura attività connettore.
- Nella colonna Connessione, scegli dall'elenco delle connessioni disponibili la connessione Cloud Pub/Sub che hai creato in un passaggio precedente.
- Una volta scelta una connessione, viene visualizzata la colonna Tipo. Per questo esempio, seleziona Azioni e poi publishMessage dall'elenco delle azioni disponibili.
- Un'entità può essere considerata come un oggetto o una raccolta di proprietà, nell'applicazione o nel servizio connesso, che può essere esposta a un'integrazione tramite l'interfaccia di Connector. La connessione Cloud Pub/Sub non espone alcuna entità.
- Un'azione è una funzione di prima classe che viene resa disponibile per l'integrazione tramite l'interfaccia di Connector. Le funzioni sono definite nell'applicazione o nel servizio connesso e definiscono una modifica o una serie di modifiche che possono essere apportate a un'entità o alle entità. Per la connessione Cloud Pub/Sub è disponibile un'Azione
- Fai clic su Fine per completare la configurazione della connessione e chiudere il riquadro.
- Il riquadro di configurazione dell'attività Connettori per una connessione Cloud Pub/Sub mostra anche le variabili Input attività e Output attività generate automaticamente dall'entità e dall'operazione o dall'azione selezionate nel passaggio precedente per l'utilizzo nella connessione. Queste variabili sono accessibili come input per le attività o le condizioni successive configurate nell'integrazione corrente.
Per configurare Input attività:
- Fai clic sul riquadro della variabile Payload input connettore per aprire il riquadro Configura variabile.
- Nel campo Valore predefinito, inserisci il seguente testo:
{"message": "test message from integration platform"}
. - Seleziona la casella di controllo Utilizza come input per l'integrazione.
- Fai clic su Salva.
Puoi configurare varie strategie per i nuovi tentativi in modo da gestire gli errori in un'attività. Le strategie di nuovo tentativo consentono di specificare come eseguire nuovamente l'attività in caso di errore. Per ulteriori informazioni, consulta le strategie di gestione degli errori.
- Aggiungi una connessione perimetrale dall'elemento Trigger API all'elemento Connettori passando il mouse sopra un punto di controllo sull'elemento Trigger API, quindi fai clic e trascina una linea su un punto di controllo sull'elemento attività Connettori. I punti di controllo e la linea del bordo diventeranno gialli. Il bordo indica il flusso di controllo dall'attività Trigger Trigger all'attività Connectors.
- Fai clic sul pulsante Pubblica nella barra degli strumenti di Designer delle integrazioni.
- Fai clic su Test per avviare l'integrazione ed eseguirla. Si aprirà la finestra Test Integration (Verifica integrazione), che mostra la variabile di input (messaggio) impostata in un passaggio precedente. Se vuoi, puoi modificare la variabile di input qui.
- Fai clic su Testare l'integrazione.
- In caso di esito positivo, la finestra Test Integration (Verifica integrazione) mostrerà un messaggio di operazione riuscita, insieme al valore dei payload delle variabili di input e di output di integrazione.
- Fai clic su Close (Chiudi) per uscire dalla finestra Test Integration (Integrazione di test).
- Vai alla pagina Pub/Sub. Seleziona l'argomento Pub/Sub, quindi fai clic su Visualizza messaggi per confermare la ricezione del messaggio inviato dall'integrazione.
- Controlla i log di integrazione Apigee per visualizzare lo stato di una determinata integrazione. Per visualizzare i log:
- Fai clic su Log nella barra degli strumenti di Designer di integrazioni.
- Nella pagina Log di esecuzione, puoi visualizzare i dettagli di ogni tentativo di esecuzione di un'integrazione.
Ogni voce include dettagli per il tentativo di esecuzione, tra cui:
- Nome integrazione
- ID esecuzione
- Stato
- Data/ora di inizio
- Durata
- ID integrazione
- ID trigger
- 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 delle variabili.
- Consulta l'elenco dei connettori supportati in Apigee.
- Scopri come creare e gestire le connessioni.
Attiva i servizi richiesti
L'opzione Connectors richiede l'abilitazione dei seguenti servizi Google:
Nome | Titolo |
apigee.googleapis.com |
API Apigee |
secretmanager.googleapis.com |
API Secret Manager |
connectors.googleapis.com |
API Connector Platform |
Se questi servizi non sono stati abilitati in precedenza per il tuo progetto, ti verrà chiesto di abilitarli quando crei la connessione nella pagina Crea connessione.
Crea una connessione Cloud Pub/Sub
Per configurare una connessione:
Crea una nuova integrazione
Per creare una nuova integrazione, procedi nel seguente modo:
Configurare un trigger
Gli attivatori sono necessari per avviare la sequenza di attività che costituiscono un'integrazione. Puoi utilizzare qualsiasi trigger per avviare un'integrazione. Questo tutorial utilizza il trigger dell'API per richiamare direttamente l'esecuzione dell'integrazione.
Aggiungi un trigger API
Per aggiungere un attivatore API a un'integrazione nuova o esistente, segui questi passaggi:Configura il trigger dell'API
Fai clic sull'elemento Trigger API nella sezione Designer di integrazione per visualizzare il riquadro della configurazione trigger.
Il riquadro di configurazione mostra l'ID attivatore, che è un ID generato automaticamente dalla macchina nel formato api_trigger/TRIGGER_NAME
.
Non sono richieste altre configurazioni per questo attivatore.
Aggiungere e configurare attività
Un'attività è un insieme di passaggi eseguibili che può utilizzare variabili come input e generare variabili come output. Come per gli attivatori, è possibile utilizzare qualsiasi attività disponibile in un'integrazione.
Questo tutorial utilizza l'attività Connettori. I dettagli di configurazione dell'attività sono descritti nella procedura seguente.
Configurare l'attività Crea connettori con una connessione Cloud Pub/Sub
Per configurare l'attività Connettori in Apigee Integration per utilizzare la connessione Cloud Pub/Sub:
Verificare l'integrazione
Per testare la nuova integrazione:
Per verificare l'esito positivo dell'integrazione:
Complimenti! Hai appena creato e testato una connessione Cloud Pub/Sub in Apigee Integration.