XM Wissensbasis
Grundlegende Übersicht der API-Erweiterung
Inhalt Dieser Seite:
Über die API-Erweiterung
Mit der Qualtrics-API können Sie sich wiederholende Prozesse in Qualtrics automatisieren oder Informationen in und aus Qualtrics übergeben. Ein Administrator kann die Qualtrics-API zum Beispiel verwenden, um die Kontoerstellung zu automatisieren, anstatt Hunderte Benutzerkonten einzeln zu erstellen. Benutzer haben zudem die Möglichkeit, die Erstellung von Kontaktlisten zu automatisieren, anstatt Kontaktlisten manuell zusammenzustellen und zu importieren. Qualtrics verfügt auch über verschiedene API-Lösungsratgeber (EN), anhand derer Sie bestimmen können, wie Sie die API am besten für Ihre Anforderungen einsetzen können.
API-Zugriff für verschiedene Produkte
Qualtrics bietet eine Vielzahl verschiedener Produkte, mit denen Sie verwertbare Daten in Echtzeit erfassen können. Einige dieser Produkte enthalten die Umfrageplattform, Site Intercept und XM Directory (Target Audience). Sobald Sie das Qualtrics-API-Merkmal erworben haben, können Sie sie für alle Produkte verwenden, die Teil Ihrer Lizenz sind.
Hier finden Sie Links zur Dokumentation der neuesten API-Version für jedes unserer Produkte:
Wir empfehlen unseren Kunden, immer die neueste Version der API zu verwenden.
Überblick über die Qualtrics v3-API
Die Qualtrics v3-API ist eine REST-API, die Ihnen die Kommunikation mit unserem System bzw. Abfragen unseres Systems mit einer einfachen URL-Syntax ermöglicht. Die Kommunikation mit dem Qualtrics-System können Sie sich als eine Abfolge von Anforderungen vorstellen. Sie können anfordern, dass Informationen an Qualtrics gesendet, aktualisiert, entfernt oder an das System zurückgegeben werden. Diese Anforderungen können Sie mit den Anforderungen GET, POST, PUT oder DELETE erstellen, die JSON-Antworten zurückgeben.
Auf diese Weise können Sie über die Qualtrics-API mit Teilen des Qualtrics-Systems interagieren und diese Bereiche in Ihr CRM integrieren.
Erste Schritte
Das aktuelle Qualtrics-API-System verwendet eine Stamm-URL zur Durchführung von Anforderungen:
https://yourdatacenterid.qualtrics.com/API/
Die Stamm-URL ist die Grundlage für jede API-Anforderung. Beachten Sie, dass es sich bei dem Protokoll um https handelt. Es ist also verschlüsselt, sodass der Schutz Ihrer Anmeldeinformationen sichergestellt ist.
Tipp: Wir empfehlen Ihnen, yourdatacenterid.qualtrics.com zuzulassen, wenn Sie unsere API hinter einer Firewall verwenden.
Sie finden Ihre Rechenzentrums-ID, indem Sie sich in Ihrem Benutzerkonto anmelden und sich die URL in der Adressleiste des Browsers ansehen. Der Teil vor qualtrics.com ist Ihre Rechenzentrums-ID. Wenn Sie nicht die richtige Rechenzentrums-ID verwenden, erhalten Sie bei der Ausführung einer API-Anforderung alternativ einen Hinweis in der HTTP-Antwort. In diesem wird die Rechenzentrums-ID angegeben, die Sie stattdessen verwenden sollten. Im unten stehenden Beispiel ist das Rechenzentrum au1.
Übergebene Parameter
Parameter sind die Bausteine Ihrer Anforderungen. Bei jeder API-Anforderung müssen neben mehreren globalen Parametern auch anforderungsspezifischere sowie einige optionale Parameter an Qualtrics übergeben werden.
Sie müssen immer das API-Token über die Kopfzeile der Anforderung als X-API-TOKEN übergeben. Je nach ausgeführter Anforderung müssen Sie eventuell weitere Parameter über die Kopfzeile, die URL oder den Text der Anforderung übergeben. Bei der Übergabe von Parametern über den Text müssen Sie die Parameter als JSON senden. In diesem Fall müssen Sie einen Content-Typ (Anwendung/JSON oder Multipart/Form-Data) angeben.
Beispiel: Im folgenden POST-Beispiel geben wir in cURL die Basis-URL, den Content-Typ und den Token in der Kopfzeile an. Die Umfrage-ID und das Format des Exports werden im Text angegeben.
curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{
„surveyId“: „SV_012345678912345“,
„format“: „csv“
}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'
Generieren eines API-Tokens
Für den Zugriff auf die Qualtrics-API ist ein API-Token erforderlich. Jeder Benutzer einer Lizenz muss ein eigenes API-Token generieren. Das API-Token Ihres Benutzerkontos ist erforderlich, um jede von Ihnen erstellte API-Anforderung zu authentifizieren. Das Token wird anstelle Ihres Benutzerkontopassworts verwendet und steigert die Sicherheit Ihrer Arbeit. Fügen Sie Ihr Token zur Authentifizierung unter der HTTPS-Kopfzeile X-API-TOKEN ein.
So generieren Sie ein API-Token:
- Klicken Sie auf das Symbol für die Benutzereinstellungen in der oberen rechten Ecke Ihres Benutzerkontos.
- Wählen Sie Kontoeinstellungen.
- Klicken Sie in der Navigationsleiste auf Qualtrics-IDs.
- Klicken Sie im Feld API auf Token generieren.
API OAuth
OAuth 2.0 ist ein von der IETF 2012 vorgeschlagenes Framework. Wenn Sie API-Aufrufe ausführen, generieren Sie ein Token (EN). Manchmal möchten Sie eventuell mit Dritten zusammenarbeiten, möchten aber Ihre Anmeldeinformationen oder dieses Token nicht an sie weitergeben, da sie über das Token später Zugriff auf Ihre API hätten. Sie möchten aber auch nicht andauernd neue Token erstellen, da dadurch andere von Ihnen eingerichtete API-Aufrufe ungültig werden.
Stattdessen können Sie mit API OAuth ein temporäres Kundengeheimnis erstellen. Dieses Kundengeheimnis wird nach einer Stunde „aktualisiert“, sodass es nicht mehr funktioniert. Weitere Informationen über API OAuth und die Verwendung in API-Aufrufen finden Sie in unserer offiziellen API-Dokumentation (EN).
Erstellen eines Kundengeheimnises
- Klicken Sie auf das Symbol für die Benutzereinstellungen in der oberen rechten Ecke Ihres Qualtrics-Benutzerkontos.
- Wählen Sie Kontoeinstellungen.
- Navigieren Sie zu Qualtrics-IDs.
- Wählen Sie OAuth Kundenbetreuer.
- Klicken Sie auf Kunden erstellen.
- Geben Sie einen Namen des Kunden ein.
- Falls gewünscht, geben Sie eine E-Mail-Adresse des Kontakts ein.
- Wählen Sie für Genehmigungstyp Anmeldeinformationen aus.
- Klicken Sie auf Kunden erstellen.
- Notieren Sie die Kunden-ID und das Kundengeheimnis und speichern Sie beides an einem sicheren Ort.
Vorsicht: Sobald Sie dieses Fenster verlassen, ist das Kundengeheimnis unwiederbringlich. Wenn Sie Ihr Kundengeheimnis verlieren oder vergessen, müssen Sie den obigen Prozess wiederholen, um ein neues zu generieren.
Mobile App-SDK
Um Ihr Mobile App-Feedbackprojekt (EN) zum Laufen zu bringen, müssen Sie eine Erweiterung auf Ihrer Seite implementieren. Das Mobile App-SDK (Software Developer's Kit) finden Sie auf den folgenden Seiten: