Web-Service-Aufgabe
Was finden Sie hier?
Informationen zur Aufgabe
Die Aufgabe ist nützlich, wenn Sie Erfahrung mit der API haben und verschiedene Workflows in der Qualtrics oder in einem externen Webdienst Auslöser möchten, wenn der Befragte:r die Umfrage abschließt. Wenn in Ihrer Umfrage beispielsweise die Kontakt des Befragte:r erfasst werden, kann eine Aufgabe die Kontakt anlegen API zum Hinzufügen des Befragte:r zu einer Kontaktliste.
Wir empfehlen auch, diese Web-Service-bezogenen Seiten zu besuchen, um weitere Unterstützung und Hintergrund zu erhalten:
- Qualtrics Developer Hub
- Web-Service-Methoden
- API-Dokumentation
- Übergabe von Informationen über Query-Strings
- Dynamischer Text
TIPP: Diese Seite enthält Verweise auf die API von Qualtrics, eine Funktion, für die spezielle Zugriffsrechte erforderlich sind. Wenn Sie Zugriff auf diese Funktion erhalten möchten, wenden Sie sich an Ihren Instanz für weitere Informationen.
Achtung: Das Einrichten eines Webdienstes erfordert häufig fortgeschrittene Programmierkenntnisse. Unser Support-Team hilft zwar gerne bei den Grundlagen der Bereitstellung von Informationen in den Web-Service, aber wir können keine Unterstützung in Bezug auf die Programmieraspekte leisten.
Achtung: Web-Service-Aufgaben unterstützen nur die folgenden Inhaltstypen: URL-kodiert, XML, JSON und Nur-Text.
TIPP: Richten Sie Ihren Webdienst über ein API Doc ein? Ihr Setup kann viel schneller sein, wenn Sie Importieren eines Curl-Befehls.
Aufgabe einrichten
Achtung: Die Ausgabe des Aufrufs in Ihrer Aufgabe ist auf 1 MB begrenzt.
Tipp: Sie können den KI-Assistenten verwenden, um die Aufgabe einzurichten. Weitere Informationen finden Sie unter Verwendung von AI Assist für die Aufgabe.
Je nachdem, wie Sie Ihre Körperparameter formatieren möchten, wird sich das Setup geringfügig unterscheiden. Wenn Sie das JSON oder XML verwenden, geben Sie Ihren Hauptteil in das Feld Hauptteil Abschnitt. Wenn Sie URL-kodiert bevorzugen, können Sie Parameter als Query-String an die URL Feld.
Tipp: Web-Service-Aufgaben haben einen Timeout von 16 Sekunden. Wenn ein Aufruf des Web-Service länger als 10 Sekunden dauert, schlägt der Workflow fehl.
Verwendung des KI-Assistenten für die Einrichtung von Aufgabe
Achtung!: Sie können die automatische Zuordnung nur verwenden, wenn ein Administrator:in der Registerkarte Administration die Berechtigung KI-Hilfe bei der Konfiguration von Workflows für Ihre Organisation aktiviert hat.
Der KI-Assistent kann die API in Webdienstaufgaben konfigurieren, indem er die öffentlich verfügbare API liest und die Aufgabe automatisch einrichtet.
Tipp: Obwohl wir unsere Produkte ständig weiterentwickeln, kann es vorkommen, dass künstliche Intelligenz ungenaue, unvollständige oder veraltete Ergebnisse liefert. Bevor Sie eine Ausgabe aus den KI-Funktionen von Qualtrics verwenden, müssen Sie die Ausgabe auf ihre Richtigkeit überprüfen und sicherstellen, dass sie für Ihren Anwendungsfall geeignet ist. Die Ergebnisse der KI-Funktionen von Qualtrics sind kein Ersatz für die menschliche Überprüfung oder professionelle Beratung.
Berechtigungs-Credentials hinzufügen
In diesem Abschnitt wird erläutert, wie Berechtigungsanmeldeinformationen für die Aufgabe hinzugefügt werden. Sie können Anmeldeinformationen hinzufügen, indem Sie die Einfach, API oder OAuth 2.0 Methode. Um Anmeldeinformationen hinzuzufügen, klicken Sie auf Benutzerkonto hinzufügen aus dem Fenster zur Auswahl der Anmeldeinformationen.
Tipp: Alle Verbindungstypen sind mit mTLS kompatibel. mehr erfahren Sie unter Gegenseitige TLS Abschnitt.
Einfach
Für die Standardauthentifizierung müssen Sie sich mit dem Benutzernamen und Kennwort Ihres Benutzerkonto anmelden.
API-Schlüssel
Mit der API können Sie sich mit einem statischen API-Token authentifizieren.
OAuth 2.0
Die OAuth-2.0-Berechtigung erspart die Verwendung statischer API oder eines einfachen Benutzernamens und Kennworts für die Integration mit Drittanbieterplattformen. Die Aufgabe unterstützt zwei verschiedene OAuth-2.0-Autorisierungstypen: Berechtigungscode und Client-Anmeldeinformationen.
Sie können die OAuth-2.0-Berechtigung verwenden, um eine nahtlose Integration mit vielen Drittanbieterplattformen zu ermöglichen. Die Qualtrics folgt der offiziellen OAuth-Spezifikation. Einige externe Systeme können jedoch etwas andere Konfigurationen haben, was zu Inkompatibilitäten mit der OAuth-2.0-Berechtigung in der Aufgabe führt.
Die folgenden Integrationen sind einige Beispiele, die für die Arbeit mit OAuth2.0 vollständig verifiziert wurden:
- Salesforce mit der Autorisierungscode-Methode.
- Jira mit der Autorisierungscode-Methode.
- Zoom mit der Berechtigungscode-Methode.
Tipp: Beim Anlegen einer OAuth-Verbindung lautet die URLhttps://{dataCenter}.qualtrics/oauth-client-service/redirect, wobei {dataCenter} den Wert darstellt, der mit Ihrem Benutzerkonto verknüpft ist. Siehe diese Seite Hier finden Sie weitere Informationen zur Suche nach dem Rechenzentrum Ihres Benutzerkonto.
So authentifizieren Sie sich mit OAuth 2.0:
Tipp: Schließen Sie für Benutzer, die Google-OAuth-Anmeldeinformationen einrichten, den folgenden Parameter am Ende Ihres Tokenendpunkts ein: “?prompt=Einwilligung.“ Wenn Sie über vorhandene Abfrageparameter verfügen, ist das Fragezeichen nicht erforderlich.
TIPP: Wenn Sie Probleme mit der Verbindung zu Snowflake haben, stellen Sie sicher, dass die IP-Bereiche von Qualtrics auf der Zulässigkeitsliste stehen.
&Umbenennen; Anmeldeinformationen werden entfernt
Um den Namen Ihrer Anmeldeinformationen zu bearbeiten, klicken Sie auf die drei Punkte weiter dem Benutzerkonto. Um Anmeldeinformationen zu entfernen, klicken Sie auf Benutzerkonto entfernen .
Tipp: Sie können nur Anmeldeinformationen umbenennen oder entfernen, die Sie selbst hinzugefügt haben.
Warnung: Seien Sie vorsichtig beim Löschen von Anmeldeinformationen! Alle Workflows, die die Anmeldeinformationen verwenden, funktionieren nicht mehr, wenn die Anmeldeinformationen gelöscht werden.
Hinzufügen einer Kopfzeile für QUALTRICS API-Anfragen
Wenn Sie die Qualtrics API verwenden, müssen Sie Ihren API-Token als Header in Ihren Webservice aufnehmen.
Gegenseitige TLS
Gegenseitige Transportschichtsicherheit (mTLS) ist eine zusätzliche, optionale Sicherheitsschicht zusätzlich zu API (z.B. API oder OAuth). Gegenseitiges TLS stellt sicher, dass sowohl die Person, die eine Verbindung zu einem API/Web-Service herstellt, als auch die API/der Web-Service selbst über sicheren, verschlüsselten Datenverkehr in beide Richtungen verfügen. Sobald mTLS aktiviert ist, müssen alle Anforderungen das richtige Client-Zertifikat enthalten, damit die Anforderungen erfolgreich sind. Wenn ein Aufrufer eine Anforderung mit einem ungültigen oder fehlenden Client-Zertifikat stellt, blockiert das API, das er aufruft, die Anforderung.
Anforderungen
Jeder Service unterscheidet sich darin, ob er mTLS unterstützt und welche Formate er in wichtige Informationen bereitstellt. Es wird garantiert, dass wir mTLS nur für Services unterstützen, die unseren Anforderungen entsprechen:
- Einen privaten Schlüssel bereitstellen
- Privater Schlüssel kann in PKCS8 formatiert werden
- Zertifikat bereitstellen
- Zertifikat kann in X.509 formatiert werden
Die öffentlichen Qualtrics unterstützen mTLS wie oben beschrieben.
mTLS wird nur unterstützt für Authentifiziert Webdienste erstellt in Workflows. Alle drei Authentifizierungsmethoden werden unterstützt (Standard, API und OAuth2.0).
mTLS hinzufügen
Tipp: Die Gültigkeit Ihrer mTLS kann erst getestet werden, wenn Sie einen API über Ihren Webdienst ausführen. Daher wird auf dieser Seite keine Fehlermeldung angezeigt, wenn Sie Ihre Schlüssel falsch eingegeben haben. Versuchen Sie es Test den Web-Service, bevor Sie Ihren Workflow produktiv setzen.
Curl-Befehle verwenden
Curl-Befehle sind eine von vielen Möglichkeiten, HTTP-Anforderungen zu stellen, und sind ein wertvolles Werkzeug, um Informationen über URLs hin und her zu übergeben. Sie können einen curl-Befehl importieren, während Sie Ihre Aufgabe so einrichten, dass verschiedene Webdienstkonfigurationen automatisch ausgefüllt werden.
Viele API stellen häufig Curl-Beispiele bereit, die Sie verwenden können. Wenn Sie diese Befehle kopieren und importieren können, kann das Einrichten von Web-Services viel schneller und einfacher werden.
Beispiele für Curl-Anforderungen finden Sie auf der rechten Seite zu jedem dieser API:
- Mailingliste abrufen
- ERINNERUNG VERTEILUNG erstellen
- Kontakt Transaktion aktualisieren
- Benutzer in Gruppe auflisten
Für eine GET-Anfrage kann der curl-Befehl so einfach sein wie curl https://api.example.com/parameters. Für Curl-Befehle, die nicht so einfach sind, stellen wir einige allgemeine Parameter bereit.
Tipp: Wenn Sie eine vorhandene Aufgabe bearbeiten, überschreiben alle von Ihnen importierten Curl-Befehle vorherige Konfigurationen.
Tipp: Wenn Sie mehr über Curl erfahren möchten als das, was wir unten abdecken, empfehlen wir Ihnen, eine Ressource außerhalb des Qualtrics Support zu lesen, z. B. IBM-Dokumentation.
Unterstützte Curl-Befehlsparameter
Hier sind einige der Curl-Parameter, die die Aufgabe Qualtrics Web Service unterstützt:
| Parameter | Beschreibung | Curl-Befehl | Beispiel |
|---|---|---|---|
| URL | Der Endpunkt oder die Ressource, mit dem bzw. der der Web-Service interagieren soll. | Vollständige URL. | https://datacenter.qualtrics.com/API/v3/directories/ |
| HTTP Methode | Optionen wie GET, POST, PUT usw. | --X <command> oder --request <command> | Beispiel 1: --X GET Beispiel 2: --request PUT |
| Kopfzeilen | Benutzerdefinierte Kopfzeilen. | --H oder --header | Beispiel 1: --header 'Accept: application/json' Beispiel 2: --header 'Content-Type: application/json' |
| Text | Der Hauptteil (oder die Payload) für POST Anforderungen. | --d oder --data | --data '{ “description”: “Listet alle offenen Bugs auf”, “jql”: “type = Bug and resolution is empty”, “name”: “Alle offenen Bugs” }’ |
| JSON | Ersetzen Sie die Angabe der JSON im Kopf und in den Daten. | --json | Dieser curl-Befehl ersetzt die folgenden 3 Tags: --data [arg] --header "Content-Type: application/json" --header "Accept: application/json" |
Allgemeine Kopfparameter
Oben wurde erwähnt, dass Sie Curl-Befehle verwenden können, um Header zu definieren. Header dienen verschiedenen Zwecken in der kommunikation, z.B. der Bereitstellung von Informationen über die Anfrage und der Steuerung der Authentifizierung. Die spezifischen Kopfzeilen, die Sie verwenden, hängen von den Anforderungen der von Ihnen verwendeten Anwendung oder API ab.
Im Folgenden finden Sie einige Beispiele für Kopfparameter:
| Name | Beschreibung | Beispiel |
|---|---|---|
| Akzeptieren | Geben Sie die Medienformate für die Antwort an. | Accept: application/json |
| Inhaltstyp | In einer Anfrage gibt der Inhaltstyp den Medientyp der Ressource an, die an den Server gesendet wird. In der Antwort gibt der Inhaltstyp den Medientyp der Ressource an, die im Nachrichtentext enthalten ist. | Content-Type: application/json |
| Autorisierung | Geben Sie Anmeldeinformationen für den Zugriff auf eine geschützte Ressource an. | Authorization: Bearer token |
| ETag | Geben Sie eine eindeutige ID für eine bestimmte Version einer Ressource an. | ETag: "123456" |
| Content-Length | Legen Sie die Größe des Entity-Bodys in der Nachricht fest. | Content-Length: 1024 |
| Ursprung | Geben Sie die Herkunft der Anforderung an. Dies kann bei Cross-Origin Resource Sharing (CORS) helfen. | Origin: https://example.com |
Nicht unterstützte Parameter
Alle oben nicht aufgeführten Curl-Parameter sind nicht unterstützt. Im Folgenden finden Sie einige Beispiele für Curl-Befehlsformate, die Qualtrics nicht unterstützt werden:
- --cookie um Cookies mit der Anfrage zu senden.
- --L oder --location für folgende Weiterleitungen.
- --max-time zur Einstellung der maximalen Abfragezeit.
- --o oder --output zum Speichern der Antworten in einer Datei.
- --insecure um unsichere Verbindungen zuzulassen.
- --A oder --user-agent, um den Benutzeragenten anzugeben.
Tipp: Wenn Sie versuchen, einen curl-Befehl mit nicht unterstützten Parametern zu importieren, wird eine Fehlermeldung mit den von Ihnen verwendeten nicht unterstützten Parametern angezeigt. Sie erhalten die Möglichkeit, mit dem Import Ihres curl-Befehls fortzufahren, wobei die nicht unterstützten Parameter entfernt werden.
Curl-Befehle importieren
Tipp: Wir empfehlen, Ihre Felder nochmals zu prüfen, bevor Sie Ihren Workflow aktivieren.
FAQs
Habe ich Zugriff auf alle Erweiterungen, die über die Workflow-Vorlagen verfügbar sind?
Habe ich Zugriff auf alle Erweiterungen, die über die Workflow-Vorlagen verfügbar sind?
Gibt es einen Link zu allen Workflow-Ereignisauslösern, Kontrollabläufen und Aufgaben?
Gibt es einen Link zu allen Workflow-Ereignisauslösern, Kontrollabläufen und Aufgaben?
Was sind Workflow-Vorlagen?
Was sind Workflow-Vorlagen?
Was sind Workflows? / Wo sind Aktionen?
Was sind Workflows? / Wo sind Aktionen?
Im Rahmen dieser Aktualisierung gibt es keine Änderungen an der Workflow-Funktion.
Wie füge ich eine Erweiterung zu meinem Qualtrics-Konto hinzu oder entferne diese?
Wie füge ich eine Erweiterung zu meinem Qualtrics-Konto hinzu oder entferne diese?
Großartig! Vielen Dank für die Rückmeldung!
Vielen Dank für die Rückmeldung!