Trigger API

I trigger API vengono utilizzati per richiamare direttamente le esecuzioni delle integrazioni.

La configurazione di un trigger API nell'integrazione ti consente di:

Per iniziare a utilizzare i trigger API, consulta il tutorial Fulfillment API. Il tutorial mostra come creare un'integrazione con un trigger API che riceve richieste API per il recupero dei dati dei clienti.

Aggiungi un trigger API

Per aggiungere un trigger API alla tua integrazione, segui questi passaggi:
  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 Elenco delle 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 nella barra degli strumenti dell'integrazione.
    4. Fai clic su Crea.

    L'integrazione appena creata si apre nell'editor delle integrazioni.

  4. Nella barra di navigazione dell'editor delle integrazioni, fai clic su Trigger per visualizzare l'elenco dei trigger disponibili.
  5. Fai clic sull'elemento Trigger API e posizionalo nel designer.

Configura un trigger API

Per configurare un trigger API, fai clic sull'elemento Trigger API nell'editor delle integrazioni. Viene visualizzato il riquadro di configurazione del trigger API che mostra i seguenti campi:

  • Etichetta: il nome visibile del trigger API nell'integrazione. Puoi modificare l'etichetta con un nome a tua scelta.
  • Note: puoi aggiungere note al trigger API per fornire ulteriori informazioni sul trigger.
  • ID trigger: un ID univoco assegnato al trigger API nel formato api_trigger/TRIGGER_NAME.
  • Variabili di input: variabili di input specifiche del trigger che puoi utilizzare per impostare il payload della richiesta per il trigger API.
    • Per aggiungere o rimuovere variabili di integrazione esistenti al trigger API, fai clic su Modifica e seleziona le variabili richieste dal riquadro Variabili di input del trigger API.
    • Per aggiungere una nuova variabile, in particolare per il trigger API selezionato, fai clic su Modifica e seleziona + Aggiungi nuova variabile dal riquadro Variabili di input del trigger API. Per informazioni sui tipi di dati supportati, consulta Tipi di dati delle variabili supportati.
  • Variabili di output: variabili di output specifiche del trigger che puoi utilizzare per impostare il payload della risposta per il trigger API.
    • Per aggiungere o rimuovere variabili di integrazione esistenti al trigger API, fai clic su Modifica e seleziona le variabili richieste dal riquadro Variabili di output del trigger API.
    • Per aggiungere una nuova variabile, in particolare per il trigger API selezionato, fai clic su Modifica e seleziona + Aggiungi nuova variabile dal riquadro Variabili di output del trigger API. Per informazioni sui tipi di dati supportati, consulta Tipi di dati delle variabili supportati.

Visualizza la specifica OpenAPI per il trigger API

Application Integration offre la possibilità di generare e visualizzare dinamicamente le specifiche OpenAPI delle integrazioni pubblicate configurate con uno o più trigger API. Per informazioni su come visualizzare la specifica OpenAPI, consulta Visualizza la specifica OpenAPI per l'integrazione.

Richiama un trigger API utilizzando una chiamata API

Dopo aver pubblicato un'integrazione con un trigger API configurato, puoi utilizzare il metodo projects.locations.integrations.execute per richiamare il trigger da qualsiasi applicazione. Questo metodo attiva l'esecuzione in modalità sincrona.

Sintassi

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"triggerId":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Sostituisci quanto segue:

  • TIMEOUT_SECONDS: il timeout in secondi per la chiamata API. Per impostazione predefinita, il timeout è di 120 secondi. Per un elenco di parametri di richiesta predefiniti, consulta Parametri di sistema.
  • TRIGGER_NAME: il nome del trigger API nell'integrazione.
  • PROJECT_ID: l'ID del tuo progetto Google Cloud .
  • LOCATION: la regione dell'integrazione, ad esempio us-east1.

Esempio

L'esempio seguente richiama un'integrazione nella regione us-east1 contenente il trigger API test_API_1 nel progetto Google Cloud demo-project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300" \
    -d '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/integrations/-:execute"

Considerazioni

Quando utilizzi il trigger API, la dimensione cumulativa di tutte le variabili di input può essere al massimo di 8 MB. Se le dimensioni superano gli 8 MB, Application Integration non esegue l'integrazione e riceverai un errore.

Quote e limiti

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

Passaggi successivi