Häufige API-Anwendungsfälle

Über API-Anwendungsfälle

Diese Seite zeigt, wie andere Qualtrics-Kunden die Qualtrics-API nutzen. Nachfolgend finden Sie eine Liste der häufigsten API-Anfragen, die unsere Kunden verwenden, sowie die mit jeder Anfrage verbundenen Anwendungsfälle.

Gängige Methoden

Web-Service

Die Automatisierung der Erstellung von API-Anfragen wird in der Regel von einem IT-Spezialisten in Ihrer Organisation durchgeführt, da dieser Prozess die Implementierung von benutzerdefiniertem Code erfordert. In einigen Fällen können Sie jedoch anstelle von benutzerdefiniertem Code eine Qualtrics-Umfrage zum Automatisieren verwenden. Die folgenden Schritte zeigen, wie Sie diesen Vorgang durchführen.

Befolgen Sie die folgenden Schritte, sobald Ihre Umfrage erstellt wurde:

1. Navigieren Sie zur Registerkarte Umfrage und öffnen Sie Ihren Umfragenverlauf.
   
2. Klicken Sie auf Unterhalb hinzufügen oder Neues Element hier hinzufügen.
3. Wählen Sie Web Service.
4. Fügen Sie die URL für die API-Anforderung aus dem Abschnitt Definition der Dokumentation ein.
   
5. Wählen Sie die Methode aus, die Sie verwenden möchten (d. h. GET, PUT, POST oder DELETE).
   Achtung: Obwohl PATCH im Webdienstelement verfügbar ist, kann es nicht mit der Qualtrics-API verwendet werden.
6. Klicken Sie auf Benutzerdefinierte Kopfzeile zum Versand an Web Service hinzufügen.
7. Geben Sie X-API-TOKEN in das Feld Kopfzeile zum Web Service und Ihr Token in das Feld Wert ein.
   
8. Fügen Sie alle erforderlichen Kopfzeilen-Parameter für Ihre API-Anforderung hinzu, indem Sie auf das Pluszeichen (+) klicken.
9. Wenn Sie die Methode auf POST oder PUT eingestellt haben, klicken Sie auf Textparameter zum Versand an Webservice hinzufügen und geben Sie alle erforderlichen Parameter und Werte ein.
10. Legen Sie den Wert für jeden Parameter rechts fest.
    Tipp: Sie möchten dynamischen Text für Werte mit dynamischen Daten wie Vorname, Nachname und E-Mail verwenden.

    

11. Wenn Sie API v2.x im Element Web Service verwenden, müssen Sie anschließend auf Abfrageparameter zum Versand an Webservice hinzufügen klicken, um die URL-Parameter und Werte für die Anfragen hinzuzufügen.

JSON

Sie können Ihre Parameter als JSON über den Text der Anfrage übergeben. Beachten Sie, dass Sie bei Verwendung dieser Methode einen Content-Type (d. h. application/json oder text/json) angeben müssen. Diese Methode wird in der Regel von einem IT-Spezialisten in Ihrer Organisation durchgeführt, da dieser Prozess die Implementierung von benutzerdefiniertem Code erfordert.

Query-String

Root URL:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.phpFügen Sie

für den ersten Parameter, der der Root-URL hinzugefügt wird, ein „?“ ein. gefolgt vom Namen des Parameters, einem Gleichheitszeichen und dem Wert des Parameters (z.B. ?Version = 2.4). Fügen Sie alle nachfolgenden Parameter mit einem führenden kaufmännischen Und “&” hinzu (z.B. &Request=importPanel).

Root-URL + Erforderliche Parameter:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML

Fügen Sie weitere zusätzliche Parameter zu Ihrer URL hinzu oder fügen Sie diese hinzu, indem Sie den oben beschriebenen Prozess befolgen. Sobald Sie alle Ihre gewünschten Parameter aufgenommen haben, haben Sie eine abgeschlossene Anfrage.

Root-URL + Erforderliche Parameter + Zusätzliche Parameter:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML&LibraryID=UR_123456789012345678Name&Token=

&ColumnHeaders=1&Contronamp;Email=3&WAP.URL%3ps%3SP3Test Xtrij3;QualnHeaders=1&Email=3&wED%URL=https%SP3trij3%trij3;QualnHeaders=1&Email=3℘URL%3ps%SP3SP3Test%trij3;QualnHeaders=1&Email=3&coamp;URL%3ps%SP3SP3trijA%trijs.com

Weitere Informationen zu Query-Strings finden Sie auf unserer Support-Seite Übergabe von Informationen über Query-Strings.

Umfrageplattform

Automatisierung des Imports einer Kontaktliste

Sie können die Importanfrage Kontakte erstellen verwenden, um Batches von Kontakten in Ihr Qualtrics-Konto zu importieren. Durch diese Anfrage können Sie JSON-Listen von Einzelpersonen aus Ihrem CRM in Qualtrics importieren. Diese Kontakte können importiert werden, indem entweder eine JSON-Datei hochgeladen und der Kopfzeilen-Parameter Content-Type auf multipart/form-data gesetzt wird, oder indem die Kontakte in den Text der Anfrage aufgenommen werden und der Content-Type auf application/json gesetzt wird.

Automatisieren der Erstellung eines Kontakts

Anstatt Kontaktlisten manuell mit neuen Kontaktmitgliedern zu aktualisieren, können Sie den Prozess mithilfe der Anfrage Kontakt anlegen automatisieren. Diese Anforderung fügt einen neuen Kontakt zu einer vorhandenen Kontaktliste hinzu. Für diese Anfrage benötigen Sie die Mailinglisten-ID und alle anderen Felder, die Sie dem Kontakt hinzufügen möchten. Diese müssen durch den Anforderungstext übergeben werden, indem Content-Type auf application/json gesetzt wird.

Generieren Ihrer eigenen individuellen Links

Möglicherweise müssen Sie Ihre Umfrage nicht über den Qualtrics-Mailer, sondern über einen internen Mailer verteilen. Mit der Qualtrics-API können Sie individuelle Links erstellen, die die persönlichen Informationen eines Befragten nachverfolgen, ohne den Qualtrics-Mailer verwenden zu müssen.

Um diese Aufgabe auszuführen, müssen Sie zwei API-Anforderungen verwenden: Verteilungs- und Verteilungslinks erstellen. Bevor Sie beginnen, müssen Sie eine Kontaktliste in Qualtrics importieren, entweder manuell oder über die API-Anfrage Kontaktimport erstellen.

Relevante Parameter für die Anfrage Verteilung und Verteilungslinks erstellen:

• Mailingliste-ID (jede Verteilung ist mit einer Mailingliste verknüpft)
• Umfrage-ID
• Beschreibung (Name der Verteilung)
• Aktion (der Wert hier muss CreateDistribution sein)

Automatisieren Sie Ihren Datendownload in Vorbereitung auf den Import in Ihr CRM

Wenn Sie feststellen, dass Sie täglich Daten aus vielen Umfragen benötigen, können Sie unsere API verwenden, um Antworten zu erhalten. Die API v3 verwendet eine Reihe von drei Anfragen, um Daten zu erhalten:

• Antwortexport anlegen: Diese Anforderung startet den Exportprozess und wird verwendet, um das Dateiformat und andere Einstellungen anzugeben. Dadurch wird eine Antwort Export ID zurückgegeben.
• Fortschritt des Antwortexports abrufen: Diese Anfrage wird verwendet, um den Fortschritt des Exports anhand der in der ersten Anfrage angegebenen Antwort-Export-ID zu prüfen. Sobald percentComplete 100 erreicht hat, können Sie die letzte Anforderung verwenden, um die Datei zu erhalten.
• Antwort-Exportdatei abrufen: Sobald die Datei fertig ist, können Sie sie mit dieser Anfrage herunterladen. Sie wird als komprimierte Datei exportiert. Bitte beachten Sie, dass zwar die meisten API-Anfragen funktionieren, wenn die Rechenzentrums-ID in der URL nicht korrekt ist, diese Anfrage jedoch nicht. Bitte stellen Sie sicher, dass Sie in dieser Anfrage die richtige Rechenzentrums-ID verwenden.

Diese Abfolge von Anfragen lädt Ihre Rohdaten herunter, was es Ihnen erleichtert, Ihre Daten zu erhalten und diese Antworten dann in Ihr CRM, Data Warehouse usw. zu importieren.

XM Directory

Aktualisieren eines Kontakts (Verzeichniskontakte auflisten und Verzeichniskontakt aktualisieren)

Manchmal möchten Sie vielleicht einen Kontakt über die API aktualisieren. Um dies zu tun, benötigen Sie die Kontakt-ID des Kontakts. Mit der API-Abfrage Verzeichniskontakte auflisten können Sie die Kontakt-ID eines Kontakts nachschlagen, die Sie dann für spätere API-Anfragen verwenden können. Wir erklären zunächst die API-Anfrage Verzeichniskontakte auflisten und dann Verzeichniskontakt aktualisieren.

Für die Anforderung der Listenverzeichniskontakte benötigen Sie lediglich die Verzeichnis-ID. Das Ergebnis für die Anfrage Verzeichniskontakte auflisten ist, dass Sie die Kontakt-ID des Kontakts erhalten, die Sie dann für Anfragen wie Verzeichniskontakt aktualisieren verwenden können.

Es gibt dann zwei Hauptparameter, die für die Anfrage Verzeichniskontakt aktualisieren von Interesse sind: Verzeichnis-ID und Kontakt-ID. Als Ergebnis der Anfrage Verzeichniskontakt aktualisieren wird der angegebene Kontakt mit den Informationen aktualisiert, die Sie basierend auf den Parametern Ihrer Anfrage geändert haben.

API-Lösungsratgeber

Auf unserer Website zur v3-API-Dokumentation finden Sie verschiedene Lösungsleitfäden für die Verwaltung von Umfragen, die Verwaltung von Benutzern, die Verwaltung von Benutzergruppen und das Abrufen von Umfrageantworten.