Einführende Informationen

Die Integration von Survio mit internen Systemen kann über API erfolgen. Hier finden Sie eine Kurzanleitung, die Ihnen den Einstieg erleichtert. 

 

Hinweis: Der API-Zugang ist nur für unsere Survio PRO-Kunden verfügbar.

 

Survio bietet eine API zum automatischen Abrufen von Daten aus verschiedenen Quellen. Diese Daten können für weitere Analysen oder Prozessimplementierungen verwendet werden. Sie können Ihren Kunden beispielsweise eine Zufriedenheitsumfrage schicken und Survio die Antworten automatisch an Ihr CRM oder ein beliebiges BI-Tool weiterleiten lassen, um die Daten weiter zu verfolgen und auszuwerten. Dies gibt dem Management die Möglichkeit, schnell und richtig zu handeln oder langfristig und konsequent zu planen.

 

Die Survio-API folgt dem Open-API-Standard und dieses Schema steht ebenfalls zum Download bereit.

 

Quellen

Gegenwärtig ermöglicht die API den Zugriff auf eine einzige Quelle - individuelle Antworten.

 

Verwendung der API

Eine Anfrage an die API wird über HTTP an den Host "https://api2.survio.com/v2/" gerichtet. Um die Daten lesen zu können, müssen jedoch die Anmeldedaten eingeholt werden. 

 

Zur Ausführung von Anfragen ist eine Autorisierung erforderlich, die über ein API-Token erfolgt. Das Token wird in einer HTTP-Kopfzeile mit folgendem Format gesendet: 

 

Authorization: Bearer <token>

 

Ein Beispiel für eine Anfrage, um Antworten zu erhalten, würde wie folgt aussehen:

 

Example request

 

Das Token wird speziell für Ihr Konto erstellt, so dass Sie nur auf Daten innerhalb Ihres Kontos zugreifen können. Das Token hat kein Verfallsdatum, kann aber auf Antrag gelöscht werden. 

 

Um einen Token zu generieren, wenden Sie sich bitte an unseren Kunden-Support.

 

Jeder, der über ein Token verfügt, kann über die API im Nur-Lese-Modus auf Ihre Kontodaten zugreifen. Obwohl es nicht möglich ist, die Daten zu löschen oder anderweitig zu beschädigen, empfehlen wir, das Token sicher aufzubewahren, um Missbrauch zu verhindern. Das aktuelle Token kann jederzeit deaktiviert und bei Bedarf ein komplett neues Token generiert werden.

 

Nähere Informationen zu den einzelnen API-Funktionen finden Sie in der Referenz. 

 

Jede Quelle enthält eine URL, eine Anfragemethode, ein Anfrageschema und ein Antwortschema.

 

Paginierung und Filter

Jede Quelle, die eine Liste von Datensätzen enthält, liefert maximal 30 Ergebnisse pro Anfrage. Die Ergebnisse sind absteigend sortiert, beginnend mit dem neuesten Datensatz. Wenn Sie mehr als 30 Ergebnisse erhalten, können Sie den GET-Parameter verwenden, um einzelne Seiten mit nachfolgenden Ergebnissen anzuzeigen:

 

?page=<page number>

 

Die Seitennummerierung beginnt mit der Zahl "0":

 

“?page=0” displays the first page,
“?page=1” displays the second page,
“?page=2” displays the third page etc. until the request returns no result.

 

Bei jeder Quelle können Sie auch verschiedene Filter verwenden, um Ihre Ergebnisse einzugeben. Sie können zwischen den folgenden Optionen wählen:

  • Datum → filtert Ergebnisse nach einem bestimmten Datum

  • Von - bis → filtert Ergebnisse nach einem bestimmten Zeitintervall

  • Ausfüllzeit → filtert die Ergebnisse nach der Zeit, die zum Ausfüllen der Umfrage benötigt wird

Sie können zum Beispiel eine Aufzeichnung der Antworten erhalten, die nach einem bestimmten Datum eingegangen sind, indem Sie das folgende Format verwenden: 

 

?submitted[after]=<time>

 

Es ist auch möglich, Filter zu verketten und z. B. ein bestimmtes Zeitintervall einzustellen: 

 

?submitted[after]=<time>&submitted[before]=<time>

 

Abrufbeschränkungen

Der Hauptzweck von Abrufbeschränkungen besteht darin, den zuverlässigen Betrieb der API, die ständige Verfügbarkeit der Daten und die Verhinderung von Datenmissbrauch zu gewährleisten, damit Sie jederzeit über alle benötigten Informationen verfügen. Diese Beschränkungen gelten nur für eine Menge von 1.000 HTTP-Anfragen pro Stunde und Benutzer.

 

Möchten Sie uns ein Feedback geben?

Bevor Sie zur API-Referenz kommen, freuen wir uns über jedes Feedback, das uns hilft, die Benutzerfreundlichkeit der Survio API zu verbessern. Wenn Sie einen Fehler oder ein Problem in der API finden, können Sie uns gerne kontaktieren.