L'attività Chiama endpoint REST consente di chiamare qualsiasi API REST di terze parti dalla tua integrazione. La risposta della chiamata API REST sarà disponibile in una variabile di integrazione e può essere utilizzata in altre attività down-stream.
Prima di iniziare
- Per connetterti a un endpoint di autenticazione per la chiamata API REST, assicurati di aver creato un profilo OAuth 2.0 o collegato un account di servizio gestito dall'utente all'integrazione. Se l'API non richiede l'autenticazione, il campo Profilo di autenticazione nel riquadro di configurazione delle attività può essere lasciato vuoto. Per visualizzare un elenco delle configurazioni, consulta Proprietà di configurazione.
Se nell'integrazione sono configurati sia un profilo OAuth 2.0 sia un account di servizio gestito dall'utente, per l'autenticazione viene utilizzato per impostazione predefinita il profilo OAuth 2.0. Se non è configurato né il profilo OAuth 2.0 né un account di servizio gestito dall'utente, l'esecuzione non riesce.
- Se all'integrazione è collegato un account di servizio, concedi il ruolo IAM richiesto a quell'account di servizio in base all'URL dell'endpoint REST. Ad esempio, se l'URL dell'endpoint REST chiama un servizio Cloud Storage, devi concedere il ruolo IAM richiesto per il servizio Cloud Storage.
Per informazioni sulla concessione dei ruoli a un account di servizio, vedi Gestire l'accesso agli account di servizio.
- Assicurati che Controlli di servizio VPC NON sia configurato per l'Apigee Integration nel tuo progetto Google Cloud.
Configura l'attività di chiamata endpoint REST
Per configurare l'attività Chiama endpoint REST:
- Nell'interfaccia utente di Apigee, seleziona la tua organizzazione Apigee.
- Fai clic su Sviluppa > Integrazioni.
- Seleziona un'integrazione esistente o creane una nuova facendo clic su Crea integrazione.
Se stai creando una nuova integrazione:
- Inserisci un nome e una descrizione nella finestra di dialogo Crea integrazione.
- Seleziona una regione per l'integrazione dall'elenco delle regioni supportate.
- Fai clic su Crea.
In questo modo viene aperta l'integrazione nel designer dell'integrazione.
- Nella barra di navigazione del designer dell'integrazione, fai clic su +Aggiungi un'attività/un trigger > Tasks per visualizzare l'elenco delle attività disponibili.
- Fai clic sull'elemento Call REST Endpoint e posizionalo nell'editor di integrazione.
- Fai clic sull'elemento Endpoint REST di chiamata nel designer per visualizzare il riquadro di configurazione delle attività Endpoint REST di chiamata.
- Configura i campi visualizzati utilizzando le proprietà di configurazione dell'attività, come descritto nella tabella seguente.
Le modifiche alle proprietà vengono salvate automaticamente.
Proprietà di configurazione
La tabella seguente descrive le proprietà di configurazione dell'attività Chiama endpoint REST.
| Proprietà | Tipo di dati | Description |
| Etichetta | Stringa | (Facoltativo) Aggiungi un'etichetta per l'attività. |
| Autenticazione | Stringa | (Facoltativo) Configura e archivia i dettagli di autenticazione per le connessioni a sistemi esterni. Per maggiori informazioni, consulta Creare profili di autenticazione in Apigee Integration. |
| URL di base dell'endpoint | Stringa | URL dell'endpoint REST senza i parametri di ricerca. |
| Metodo HTTP | NA | HTTP.
Puoi selezionare uno dei seguenti metodi HTTP:
|
| Parametri della stringa di query dell'URL | Chiave stringa di query : Stringa
Valore: Stringa |
Parametri di ricerca obbligatori per la chiamata API REST.
I parametri di ricerca sono sotto forma di coppie chiave-valore, dove la chiave è il nome della chiave e il valore è il valore chiave corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più. |
| Intestazioni HTTP | Chiave intestazione HTTP: Stringa
Valore: Stringa |
Intestazioni HTTP necessarie per la chiamata API REST.
Le intestazioni HTTP sono sotto forma di coppie chiave/valore, dove la chiave è il nome della chiave e il valore è il valore chiave corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più. |
| Segui i reindirizzamenti | Booleano | Seguire i reindirizzamenti URL.
Puoi selezionare uno qualsiasi dei valori:
|
| L'attività non dovrebbe riuscire in caso di errore HTTP | Booleano | Strategia di gestione delle eccezioni in caso di errore della chiamata API REST.
L'endpoint REST di chiamata non riesce se il codice di risposta HTTP è 4xx o 5xx. Per un elenco dei codici di errore, consulta Codici di errore. Per altri codici di risposta HTTP, restituisci il codice e il messaggio di errore nella risposta.
Puoi selezionare uno qualsiasi dei valori:
|
| Intestazione della risposta (<Nome attività>) | Stringa | Intestazione della risposta non compressa dalla risposta delle API REST. |
| Corpo della risposta (<Nome attività>) | Stringa | Corpo della risposta non compresso dalla risposta dell'API REST. |
| Stato della risposta (<nome attività>) | Stringa | il codice di risposta HTTP e il testo del codice corrispondente dalla risposta dell'API REST. |
best practice
Per informazioni sui limiti di utilizzo che si applicano all'attività Chiamata endpoint REST, consulta Limiti di utilizzo.
Strategia di gestione degli errori
Una strategia di gestione degli errori per un'attività specifica l'azione da intraprendere se l'attività non riesce a causa di un errore temporaneo. Per informazioni su come utilizzare una strategia di gestione degli errori e per conoscere i diversi tipi di strategie di gestione degli errori, consulta Strategie di gestione degli errori.
Per scoprire come gestire le strategie di nuovo tentativo per gli errori 4xx o 5xx, consulta il blog Come riprovare l'attività chiamante a riposo in base allo stato della risposta.