Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Integrazione della connessione API REST
Con l'integrazione di REST API Connection in Amazon Quick, puoi eseguire azioni con REST APIs e servizi web personalizzati. Questa integrazione supporta solo l'esecuzione di azioni.
Cosa puoi fare
Con l'integrazione di REST API Connection, puoi eseguire azioni con REST APIs e servizi web personalizzati tramite il connettore di azione.
- Connettore d'azione
-
Esegui richieste HTTP, recupera dati e interagisci APIs utilizzando opzioni di autenticazione flessibili.
Nota
L'integrazione della connessione API REST non supporta l'accesso ai dati o la creazione di knowledge base. È progettato specificamente per l'esecuzione di attività e le interazioni API con servizi Web personalizzati.
Prima di iniziare
Prima di configurare l'integrazione con l'API REST, assicurati di disporre di quanto segue:
-
Endpoint API REST con autorizzazioni di accesso appropriate.
-
Credenziali di autenticazione API (OAuthchiave API o altro).
-
Documentazione API per il servizio web di destinazione.
Preparare l'endpoint e l'autenticazione dell'API
Prima di configurare l'integrazione in Amazon Quick, prepara l'endpoint dell'API REST e le credenziali di autenticazione. L'integrazione della connessione API REST supporta diversi metodi di autenticazione. Scegli il metodo che soddisfa i tuoi requisiti API:
- Autenticazione utente (OAuth)
-
Raccogli le seguenti informazioni dal tuo provider di API:
URL di base: URL di base dell'API REST.
ID client: ID client OAuth dell'applicazione.
Client Secret: segreto del client OAuth dell'applicazione.
URL del token: endpoint OAuth del token.
URL di autenticazione - endpoint di OAuth autorizzazione.
URL di reindirizzamento: OAuth URI di reindirizzamento.
- Autenticazione del servizio () Service-to-service OAuth
-
Raccogli le seguenti informazioni dal tuo provider di API:
Tipo di autenticazione: le credenziali del client OAuth 2.0 garantiscono il flusso per service-to-service l'autenticazione.
URL di base: URL di base dell'API REST.
Client ID: identificatore del client OAuth dell'applicazione per l'autenticazione del servizio.
Client secret: segreto del client OAuth dell'applicazione per l'autenticazione del servizio.
Token URL: endpoint OAuth token per ottenere token di accesso.
Intestazioni e parametri personalizzati
Puoi utilizzare intestazioni e parametri personalizzati per l'autenticazione flessibile e l'interazione con le API:
Intestazioni di autenticazione personalizzate.
Intestazioni di versione API.
Specifiche del tipo di contenuto.
Parametri di interrogazione personalizzati.
Configura l'integrazione dell'API REST
Dopo aver preparato l'endpoint dell'API e le credenziali di autenticazione, segui questi passaggi per creare l'integrazione con l'API REST:
-
Nella console Amazon Quick, scegli Integrazioni.
-
Scegli REST API Connection tra le opzioni di integrazione e fai clic sul pulsante Aggiungi (più «+»).
-
Inserisci i dettagli dell'integrazione:
-
Nome: nome descrittivo per l'integrazione con l'API REST.
-
Descrizione (opzionale): scopo dell'integrazione.
-
-
Scegli il tipo di connessione:
-
Autenticazione utente: autenticazione OAuth basata sull'accesso dei singoli utenti.
-
Autenticazione del servizio: autenticazione basata su chiave API per l'accesso al servizio.
-
-
Compila le impostazioni di connessione in base al metodo di autenticazione selezionato (utente o servizio).
-
Seleziona Avanti.
-
Esamina le azioni disponibili.
-
Seleziona Crea e continua.
Azioni delle attività disponibili
Dopo aver creato l'integrazione con l'API REST, puoi esaminare le azioni disponibili per interagire con l'API REST. Le azioni API REST più comuni includono:
Richieste HTTP GET per il recupero dei dati.
Richieste HTTP POST per la creazione di dati.
PUT/PATCH Richieste HTTP per l'aggiornamento dei dati.
Richieste HTTP DELETE per la rimozione dei dati.
Interazioni endpoint personalizzate.
Elaborazione di dati JSON e XML.
Gestione dei parametri e delle intestazioni delle query.
Nota
Le azioni specifiche disponibili dipendono dagli endpoint dell'API REST e dalle autorizzazioni di autenticazione configurate per l'integrazione.
Opzioni di configurazione dell'API
Puoi configurare vari aspetti dell'integrazione dell'API REST in base ai tuoi requisiti specifici.
Configurazione dell'endpoint
Configura queste impostazioni degli endpoint:
URL di base e percorsi degli endpoint.
Specifiche del metodo HTTP.
Gestione del formato di richiesta e risposta.
Gestione degli errori e logica dei tentativi.
Gestione dei dati
Configura il modo in cui la tua integrazione elabora i diversi formati di dati:
Elaborazione di richieste e risposte JSON.
Trasformazione dei dati XML.
Dati dei moduli e caricamenti in più parti.
Gestione dei dati binari.
Gestisci le integrazioni delle API REST
Dopo aver creato l'integrazione con l'API REST, puoi gestirla utilizzando queste opzioni:
-
Modifica integrazione: aggiorna le impostazioni di autenticazione, l'URL di base o la configurazione dell'API.
-
Condividi l'integrazione: rendi l'integrazione disponibile agli altri utenti della tua organizzazione.
-
Monitora l'utilizzo: visualizza le metriche dell'attività di integrazione e delle chiamate API.
-
Azioni di revisione: consulta l'elenco completo delle azioni API REST disponibili.
-
Endpoint di test: convalida la connettività e l'autenticazione delle API.
-
Elimina integrazione: rimuove l'integrazione e revoca l'autenticazione associata.
Importante
Le integrazioni dell'API REST dipendono dalla disponibilità e dalla configurazione del servizio web di destinazione. Le modifiche all'API o ai requisiti di autenticazione possono influire sulla funzionalità di integrazione.
