Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
REST-API-Verbindungsintegration
Mit der REST API Connection-Integration in Amazon Quick können Sie Aktionen mit benutzerdefinierten REST-APIs und Webservices ausführen. Diese Integration unterstützt nur die Ausführung von Aktionen.
Was Sie tun können
Mit der REST-API-Verbindungsintegration können Sie Aktionen mit benutzerdefinierten REST-APIs und Webdiensten über den Action Connector ausführen.
- Action-Konnektor
-
Führen Sie HTTP-Anfragen durch, rufen Sie Daten ab und interagieren Sie mit APIs mithilfe flexibler Authentifizierungsoptionen.
Anmerkung
Die REST-API-Verbindungsintegration unterstützt weder den Datenzugriff noch die Erstellung von Wissensdatenbanken. Es wurde speziell für die Ausführung von Aufgaben und API-Interaktionen mit benutzerdefinierten Webdiensten entwickelt.
Bevor Sie beginnen
Bevor Sie die REST-API-Integration einrichten, stellen Sie sicher, dass Sie über Folgendes verfügen:
-
REST-API-Endpunkt mit entsprechenden Zugriffsberechtigungen.
-
API-Authentifizierungsdaten (OAuth, API-Schlüssel oder andere).
-
API-Dokumentation für den Ziel-Webdienst.
Bereiten Sie den API-Endpunkt und die Authentifizierung vor
Bevor Sie die Integration in Amazon Quick konfigurieren, bereiten Sie Ihren REST-API-Endpunkt und Ihre Authentifizierungsdaten vor. Die REST-API-Verbindungsintegration unterstützt mehrere Authentifizierungsmethoden. Wählen Sie die Methode, die Ihren API-Anforderungen entspricht:
- Benutzerauthentifizierung (OAuth)
-
Erfassen Sie die folgenden Informationen von Ihrem API-Anbieter:
Basis-URL — REST-API-Basis-URL.
Client-ID — Client-ID der OAuth-Anwendung.
Geheimer Client-Schlüssel — Geheimer Client-Schlüssel der OAuth-Anwendung.
Token-URL — OAuth-Token-Endpunkt.
Auth-URL — OAuth-Autorisierungsendpunkt.
Weiterleitungs-URL — OAuth-Umleitungs-URI.
- Dienstauthentifizierung (OAuth) Service-to-service
-
Erfassen Sie die folgenden Informationen von Ihrem API-Anbieter:
Authentifizierungstyp — OAuth 2.0-Client-Anmeldeinformationen gewähren den Fluss für die Service-to-Service-Authentifizierung.
Basis-URL — REST-API-Basis-URL.
Client-ID — Client-ID der OAuth-Anwendung für die Dienstauthentifizierung.
Geheimer Client-Schlüssel — Client-Geheimnis der OAuth-Anwendung für die Dienstauthentifizierung.
Token-URL — OAuth-Token-Endpunkt zum Abrufen von Zugriffstoken.
Benutzerdefinierte Header und Parameter
Sie können benutzerdefinierte Header und Parameter für eine flexible Authentifizierung und API-Interaktion verwenden:
Benutzerdefinierte Authentifizierungs-Header.
Header der API-Version.
Content-Type Spezifikationen.
Benutzerdefinierte Abfrageparameter.
Richten Sie die REST-API-Integration ein
Nachdem Sie Ihren API-Endpunkt und Ihre Authentifizierungsdaten vorbereitet haben, gehen Sie wie folgt vor, um Ihre REST-API-Integration zu erstellen:
-
Wählen Sie in der Amazon Quick-Konsole Connectors aus.
-
Wählen Sie den Tab „Für Ihr Team erstellen“.
-
Suchen und wählen Sie REST API Connection aus.
-
Füllen Sie die Integrationsdetails aus:
-
Name — Beschreibender Name für Ihre REST-API-Integration.
-
Beschreibung (optional) — Zweck der Integration.
-
-
Wählen Sie Ihren Verbindungstyp:
-
Benutzerauthentifizierung — OAuth-based Authentifizierung für den individuellen Benutzerzugriff.
-
Dienstauthentifizierung — API-Schlüsselbasierte Authentifizierung für den Servicezugriff.
-
-
Geben Sie die Verbindungseinstellungen auf der Grundlage der von Ihnen ausgewählten Authentifizierungsmethode (entweder Benutzer oder Dienst) ein.
-
Klicken Sie auf Weiter.
-
Überprüfen Sie die verfügbaren Aktionen.
-
Wählen Sie Erstellen und fortfahren aus.
Verfügbare Task-Aktionen
Nachdem Sie Ihre REST-API-Integration erstellt haben, können Sie die verfügbaren Aktionen für die Interaktion mit der REST-API überprüfen. Zu den häufigsten REST-API-Aktionen gehören:
HTTP GET-Anfragen für den Datenabruf.
HTTP-POST-Anfragen zur Datenerstellung.
PUT/PATCH HTTP-Anfragen für Datenaktualisierungen.
HTTP DELETE-Anfragen zur Entfernung von Daten.
Benutzerdefinierte Endpunktinteraktionen.
JSON- und XML-Datenverarbeitung.
Verwaltung von Abfrageparametern und Headern.
Anmerkung
Die spezifischen verfügbaren Aktionen hängen von den REST-API-Endpunkten und den für Ihre Integration konfigurierten Authentifizierungsberechtigungen ab.
API-Konfigurationsoptionen
Sie können verschiedene Aspekte Ihrer REST-API-Integration so konfigurieren, dass sie Ihren spezifischen Anforderungen entsprechen.
Endpunktkonfiguration
Konfigurieren Sie diese Endpunkteinstellungen:
Basis-URL und Endpunktpfade.
Spezifikationen der HTTP-Methode.
Bearbeitung von Anfrage- und Antwortformaten.
Fehlerbehandlung und Wiederholungslogik.
Umgang mit Daten
Konfigurieren Sie, wie Ihre Integration verschiedene Datenformate verarbeitet:
Verarbeitung von JSON-Anfragen und -Antworten.
XML-Datentransformation.
Formulardaten und mehrteilige Uploads.
Umgang mit binären Daten.
REST-API-Integrationen verwalten
Nachdem Sie Ihre REST-API-Integration erstellt haben, können Sie sie mit den folgenden Optionen verwalten:
-
Integration bearbeiten — Aktualisieren Sie die Authentifizierungseinstellungen, die Basis-URL oder die API-Konfiguration.
-
Integration teilen — Stellen Sie die Integration anderen Benutzern in Ihrer Organisation zur Verfügung.
-
Nutzung überwachen — Sehen Sie sich Integrationsaktivitäten und API-Aufrufmetriken an.
-
Aktionen überprüfen — Sehen Sie sich die vollständige Liste der verfügbaren REST-API-Aktionen an.
-
Endpunkte testen — Überprüfen Sie die API-Konnektivität und Authentifizierung.
-
Integration löschen — Entfernen Sie die Integration und widerrufen Sie die zugehörige Authentifizierung.
Wichtig
REST-API-Integrationen hängen von der Verfügbarkeit und Konfiguration des Ziel-Webdienstes ab. Änderungen an den API- oder Authentifizierungsanforderungen können sich auf die Integrationsfunktionalität auswirken.
