Consulta i connettori supportati per Application Integration.

Trigger API

Gli attivatori API vengono utilizzati per invocare direttamente le esecuzioni per le integrazioni.

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

Per iniziare a utilizzare gli trigger API, consulta il tutorial sull'adempimento dell'API. Il tutorial mostra come creare un'integrazione con un trigger API che riceve richieste API per il recupero delle informazioni sui clienti.

Aggiungere un trigger API

Per aggiungere un trigger API all'integrazione, segui questi passaggi:
  1. Nella console Google Cloud, vai alla pagina Integrazione delle applicazioni.

    Vai ad Application Integration

  2. Nel menu di navigazione, fai clic su Integrations (Integrazioni).

    Viene visualizzata la pagina Elenco 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 dell'account di servizio di un'integrazione in qualsiasi momento dal riquadro Riepilogo dell'integrazione nella barra degli strumenti di integrazione.
    4. Fai clic su Crea.

    Viene visualizzata l'integrazione nell'editor di integrazione.

  4. Nella barra di navigazione dell'editor dell'integrazione, fai clic su Attivatori per visualizzare l'elenco degli attivatori disponibili.
  5. Fai clic e posiziona l'elemento API trigger nel designer.

Configurare un trigger API

Per configurare un trigger API, fai clic sull'elemento Trigger API nell'editor di integrazione. Viene visualizzato il riquadro di configurazione dell'attivatore API con i seguenti campi:

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

Visualizzare la specifica OpenAPI per l'attivatore API

L'Application Integration consente di generare e visualizzare dinamicamente le specifiche OpenAPI delle integrazioni pubblicate configurate con uno o più attivatori API. Per informazioni su come visualizzare la specifica OpenAPI, consulta Visualizzare la specifica OpenAPI per l'integrazione.

Richiamare 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 l'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 '{"trigger_id":"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 insiemi predefiniti di parametri di richiesta, consulta Parametri di sistema.
  • TRIGGER_NAME: il nome dell'trigger API nell'integrazione.
  • PROJECT_ID: l'ID del tuo progetto Google Cloud .
  • LOCATION: la posizione del tuo progetto Google Cloud .

Esempio

L'esempio seguente richiama un'integrazione nella regione us-east1 contenente l'attivatore dell'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 '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

Considerazioni

Quando utilizzi l'attivatore API, le dimensioni cumulative di tutte le variabili di input possono essere massime di 8 MB. Se le dimensioni superano gli 8 MB, l'Application Integration non viene eseguita e viene visualizzato un messaggio di errore.

Quote e limiti

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

Passaggi successivi