Chiamata dell'attività endpoint REST

L'attività Chiama endpoint REST consente di chiamare qualsiasi API REST di terze parti dalla tua integrazione. La risposta della chiamata dell'API REST sarà disponibile in una variabile di integrazione e potrà essere utilizzata in altre attività downstream.

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 service account gestito dall'utente alla tua integrazione. Se la tua API non richiede l'autenticazione, il campo Profilo di autenticazione nel riquadro di configurazione del task può essere lasciato vuoto. Per visualizzare un elenco di configurazioni, consulta Proprietà di configurazione.

    Se la tua integrazione ha configurato sia il profilo OAuth 2.0 sia un account di servizio gestito dall'utente, per impostazione predefinita viene utilizzato il profilo OAuth 2.0 per l'autenticazione. Se non è configurato né il profilo OAuth 2.0 né il account di servizio gestito dall'utente, l'esecuzione non va a buon fine.

  • Se la tua integrazione ha un account di servizio collegato, in base all'URL dell'endpoint REST, concedi il ruolo IAM richiesto a questo account di servizio. 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 ai service account.

  • Assicurati che i Controlli di servizio VPC NON siano configurati per l'Application Integration nel tuo progetto Google Cloud .

Configurare l'attività di chiamata endpoint REST

Per configurare l'attività Chiamata endpoint REST:

  1. Nella console Google Cloud , vai alla pagina Application Integration.

    Vai ad Application Integration

  2. Nel menu di navigazione, fai clic su Integrazioni.

    Viene visualizzata la pagina Integrazioni, che elenca tutte le integrazioni disponibili nel progetto Google Cloud.

  3. Seleziona un'integrazione esistente o fai clic su Crea integrazione per crearne una nuova.

    Se stai creando una nuova integrazione:

    1. Inserisci un nome e una descrizione nel riquadro Crea integrazione.
    2. Seleziona una regione per l'integrazione.
    3. Seleziona un account di servizio per l'integrazione. Puoi modificare o aggiornare i dettagli del account di servizio di un'integrazione in qualsiasi momento dal riquadro Riepilogo integrazione della barra degli strumenti di integrazione.
    4. Fai clic su Crea. L'integrazione appena creata si apre nell'editor integrazioni.

  4. Nella barra di navigazione dell'editor di integrazione, fai clic su Attività per visualizzare l'elenco delle attività e dei connettori disponibili.
  5. Fai clic sull'elemento Chiamata endpoint REST e posizionalo nell'Editor integrazioni.
  6. Fai clic sull'elemento Chiamata endpoint REST nel designer per visualizzare il riquadro di configurazione dell'attività Chiamata endpoint REST.
  7. Configura i campi visualizzati utilizzando le proprietà di configurazione dell'attività, come descritto in dettaglio nella tabella seguente.

    Le modifiche alle proprietà vengono salvate automaticamente.

Proprietà di configurazione

La tabella seguente descrive le proprietà di configurazione dell'attività Chiamata endpoint REST.

Proprietà Tipo di dati Descrizione
Etichetta Stringa (Facoltativo) Aggiungi un'etichetta all'attività.
Autenticazione Stringa (Facoltativo) Configura e archivia i dettagli di autenticazione per le connessioni a sistemi esterni. Per saperne di più, consulta Creazione di profili di autenticazione in Application Integration.
URL di base dell'endpoint Stringa URL dell'endpoint REST senza i parametri di ricerca.
Metodo HTTP ND 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 query 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 è il valore della chiave corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più.

Intestazioni HTTP Chiave dell'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 è il valore della chiave corrispondente. Puoi inserire più di una coppia chiave-valore facendo clic sull'icona Più.

Corpo della richiesta Stringa Payload della richiesta REST. Valido per i metodi HTTP POST, PUT e PATCH. La dimensione massima supportata è 20 MB.
Segui i reindirizzamenti Booleano Segui i reindirizzamenti degli 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à deve non riuscire a causa di un errore HTTP Booleano Strategia di gestione delle eccezioni quando la chiamata API REST non va a buon fine. L'endpoint REST di chiamata non riesce se il codice di risposta HTTP è 4xx o 5xx. Per un elenco dei codici di errore, consulta la sezione Codici di errore. Per gli altri codici di risposta HTTP, restituisci il codice di errore e il messaggio di errore nella risposta.

Puoi selezionare uno qualsiasi dei valori:

  • True : genera un'eccezione.
  • False: non genera un'eccezione. ma restituisce il codice di errore e il messaggio di errore nella risposta.
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 delle API REST.
Stato della risposta (<nome attività>) Stringa Codice di risposta HTTP e testo del codice corrispondente dalla risposta delle API REST.

Best practice

Per informazioni sui limiti di utilizzo che si applicano all'attività Chiama 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 sui diversi tipi di strategie di gestione degli errori, consulta 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à di chiamata REST in base allo stato della risposta.

Quote e limiti

Per informazioni su quote e limiti, consulta Quote e limiti.

Passaggi successivi