Attività chiamata endpoint REST

L'attività Chiama endpoint REST consente di chiamare qualsiasi API REST di terze parti dalla tua integrazione. La risposta alla 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 di aver 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 dell'attività può essere lasciato vuoto. Per visualizzare un elenco delle configurazioni, consulta Proprietà di configurazione.

    Se per l'integrazione sono stati configurati sia un profilo OAuth 2.0 sia un account di servizio gestito dall'utente, per impostazione predefinita verrà utilizzato il profilo OAuth 2.0 per l'autenticazione. Se non è configurato né il profilo OAuth 2.0 né un account di servizio gestito dall'utente, l'esecuzione non riesce.

  • Se alla tua integrazione è collegato un account di servizio, concedi a quell'account il ruolo IAM richiesto in base all'URL dell'endpoint REST. Ad esempio, se l'URL dell'endpoint REST chiama un servizio Cloud Storage, concedi 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 i Controlli di servizio VPC NON siano configurati per l'Apigee Integration nel tuo progetto Google Cloud.

Configura l'attività Chiama endpoint REST

Per configurare l'attività Chiama endpoint REST:

  1. Nell'UI di Apigee, seleziona la tua organizzazione Apigee.
  2. Fai clic su Sviluppa > Integrazioni.
  3. Seleziona un'integrazione esistente o creane una nuova facendo clic su Crea integrazione.

    Se stai creando una nuova integrazione:

    1. Inserisci un nome e una descrizione nella finestra di dialogo Crea integrazione.
    2. Seleziona una regione per l'integrazione dall'elenco delle regioni supportate.
    3. Fai clic su Crea.

    Viene aperta l'integrazione nel designer dell'integrazione.

  4. Nella barra di navigazione integration designer, fai clic su +Aggiungi un'attività/un attivatore > Tasks per visualizzare l'elenco delle attività disponibili.
  5. Fai clic e posiziona l'elemento Chiama endpoint REST nell'editor di integrazione.
  6. Fai clic sull'elemento Chiama endpoint REST nel progettista per visualizzare il riquadro di configurazione dell'attività Chiama endpoint REST.
  7. Configura i campi visualizzati utilizzando le proprietà di configurazione dell'attività, come descritto nella tabella riportata di seguito.

    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 Descrizione
Etichetta String (Facoltativo) Aggiungi un'etichetta per l'attività.
Autenticazione String (Facoltativo) Configura e archivia i dettagli di autenticazione per le connessioni a sistemi esterni. Per saperne di più, vedi Creare profili di autenticazione in Apigee Integration.
URL di base endpoint String URL dell'endpoint REST senza i parametri di ricerca.
Metodo HTTP NA Metodo HTTP da utilizzare.

Puoi selezionare uno dei seguenti metodi HTTP:

  • ELIMINA
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
Parametri stringa di query dell'URL Chiave della stringa di query : Stringa

Valore: stringa

Parametri di ricerca richiesti per la chiamata API REST.

I parametri di ricerca sono sotto forma di coppie chiave/valore in cui la chiave è il nome della chiave e il valore è la coppia chiave-valore corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più.

Intestazioni HTTP Chiave intestazione HTTP: Stringa

Valore: stringa

Intestazioni HTTP richieste per la chiamata API REST.

Le intestazioni HTTP sono sotto forma di coppie chiave-valore, in cui la chiave è il nome della chiave e il valore è la coppia chiave-valore corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più.

Seguire i reindirizzamenti Booleano Segui i reindirizzamenti URL.

Puoi selezionare uno qualsiasi dei valori:

  • True : chiama l'URL reindirizzato se l'URL di base dell'endpoint viene inoltrato a un altro URL.
  • False: non chiama l'URL reindirizzato se l'URL di base dell'endpoint viene inoltrato a un altro URL.
L'attività non dovrebbe andare a buon fine in caso di errore HTTP Booleano Strategia di gestione delle eccezioni quando la chiamata API REST ha esito negativo. L'endpoint di chiamata REST non riesce se il codice di risposta HTTP è 4xx o 5xx. Per un elenco dei codici di errore, vedi Codici di errore. Per altri codici di risposta HTTP, restituisci codice e messaggio di errore nella risposta.

Puoi selezionare uno qualsiasi dei valori:

  • Vero : genera un'eccezione.
  • False: non genera un'eccezione. ma restituisce il codice e il messaggio di errore nella risposta.
Intestazione della risposta (<nome attività>) String Intestazione della risposta non compressa dalla risposta delle API REST.
Corpo della risposta (<Nome attività>) String Corpo della risposta non compresso dalla risposta delle API REST.
Stato della risposta (<nome attività>) String Codice di risposta HTTP e testo di codice corrispondente dalla risposta delle API REST.

Best practice

Per informazioni sui limiti di utilizzo che si applicano all'attività Chiama endpoint REST, vedi Limiti di utilizzo.

Strategia di gestione degli errori

Una strategia di gestione degli errori per un'attività specifica l'azione da eseguire 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 l'articolo sulle strategie di gestione degli errori.

Per scoprire come gestire le strategie di ripetizione per gli errori 4xx o 5xx, consulta il blog Come riprovare l'attività del chiamante di riposo in base allo stato della risposta.