REST API

In diesem Artikel:

 

Über die API von QUESTIONSTAR

Die API (Application Programming Interface) von QUESTIONSTAR bietet Ihnen eine flexible Möglichkeit, auf Ihre Umfragedaten zuzugreifen und sie direkt in Ihre eigenen Systeme und Prozesse zu integrieren. Sie eignet sich besonders für fortgeschrittene Szenarien, die über den Funktionsumfang unserer Standardlösungen wie Power BI oder Google Looker Studio hinausgehen.

Typische Anwendungsfälle für unsere REST-API:

  • Sie möchten automatisiert Teilnehmer zu Ihrer Umfrage hinzufügen – zum Beispiel aus einem internen CRM- oder Supportsystem.
  • Sie wollen die Antworten regelmäßig exportieren und weiterverarbeiten, z. B. in einem eigenen Reporting-Dashboard.
  • Sie benötigen ein eigenes Frontend oder ein spezialisiertes Tool, das in Echtzeit mit den Umfragedaten arbeiten soll.
  • Sie möchten Ergebnisse dynamisch analysieren oder bestimmte KPIs automatisiert berechnen lassen.

Für solche Anwendungen steht Ihnen die QUESTIONSTAR API zur Verfügung. Sie basiert auf dem weit verbreiteten OpenAPI-Standard (OAS 3.0) und ist gut dokumentiert.

 

Voraussetzungen

Um die API von QUESTIONSTAR nutzen zu können, benötigen Sie:

  • Ein aktives Nutzerkonto bei QUESTIONSTAR.
  • Grundkenntnisse im Umgang mit REST-APIs.
  • Optional: einen technischen Ansprechpartner, der API-Calls in Ihrem System implementieren kann.

Die Dokumentation der API finden Sie hier:
https://api.questionstar.de/

 

Autorisierungs-Tokens für die API generieren

Damit Sie API-Calls erfolgreich ausführen können, benötigen Sie einen gültigen Autorisierungs-Token. Diesen können Sie direkt in Ihrem QUESTIONSTAR-Konto erstellen und verwalten – so geht’s:

Integrationen

  1. Klicken Sie oben rechts auf Ihren Namen
  2. und wählen Sie im Dropdown-Menü den Punkt „Integrationen“.
    API-Token generieren
  3. Wählen Sie im linken Menü den Punkt „API-Tokens“.
  4. Klicken Sie auf „+ API-Token generieren“.
    Namen vergeben
  5. Geben Sie Ihrem API-Token einen Namen, z. B. „CRM-Integration“.
  6. Klicken Sie auf „Speichern“.
    API verwalten
  7. Kopieren Sie den generierten API-Token und bewahren Sie ihn sicher auf.
  8. Falls nötig, können Sie den Token später löschen (in diesem Fall verliert er seine Gültigkeit) oder einen neuen generieren.

Tipp:
Sie können beliebig viele API-Tokens erzeugen. Wir empfehlen, für jeden Anwendungsfall – z. B. jede App oder jeden Benutzer – einen eigenen Token zu erstellen. So behalten Sie die Kontrolle über die Nutzung Ihrer Umfragedaten und können bei Bedarf gezielt den Zugriff einzelner Anwendungen oder Nutzer entziehen, ohne andere zu beeinträchtigen.

 

Autorisierung in der API-Dokumentation

Um direkt in der API-Dokumentation (Swagger-Oberfläche) Testanfragen auszuführen:

Authorize

  1. Öffnen Sie die API-Dokumentation: https://api.questionstar.de/
  2. Klicken Sie auf den Button „Authorize“ oben rechts.
  3. Fügen Sie Ihren API-Token ein.
  4. Bestätigen Sie mit „Authorize“.

Jetzt können Sie alle Endpunkte ausprobieren und direkt aus der Oberfläche testen.

 

Anwendungsbeispiele

 

Beispiel 1: Antworten exportieren

Sie möchten alle eingegangenen Antworten eines bestimmten Fragebogens automatisiert abrufen – z. B. für eine eigene wöchentliche Auswertung.

So gehen Sie vor:

  1. Rufen Sie den Endpunkt /ResultCases/GetAnswers auf.
  2. Übergeben Sie dabei die Survey-ID und optional Filterparameter (z. B. Zeitraum, Status etc.).
  3. Die Antworten werden im JSON-Format zurückgegeben und können in Ihr System übernommen werden.

Tipp:
So lässt sich z. B. ein nächtlicher Cronjob einrichten, der jeden Morgen alle neuen Antworten abruft und in Ihre Datenbank überträgt.

 

Beispiel 2: Teilnehmer automatisiert hinzufügen

Ihr Team nutzt ein CRM-System und möchte neue Kund:innen automatisch zu einer personalisierten Willkommensumfrage einladen? Oder möchten Sie nach einer Supportanfrage direkt ein individuelles Feedback einholen?

Mit der QUESTIONSTAR API können Sie genau das automatisieren – schnell, sicher und effizient.

So gehen Sie vor:

  1. Verwenden Sie den Endpunkt /Respondents/Add.
  2. Übergeben Sie dabei den Namen, die E-Mail-Adresse und – falls gewünscht – zusätzliche Felder wie z. B. Kundentyp oder Region (über Custom Fields).
  3. Optional können Sie direkt eine Einladungs-E-Mail zur Teilnahme an der Umfrage mit versenden lassen.

Das spart manuelle Arbeit, reduziert Fehlerquellen und sorgt für einen professionellen, automatisierten Ablauf – z. B. bei Onboarding-Prozessen, Supportanfragen oder internen Befragungen.

 

Fazit

Mit der API von QUESTIONSTAR stehen Ihnen leistungsstarke Möglichkeiten zur Verfügung, Ihre Umfragen flexibel und effizient in Ihre eigenen Systeme zu integrieren. Besonders dann, wenn Standardlösungen nicht ausreichen oder ein höheres Maß an Automatisierung gewünscht ist, eröffnet die API ganz neue Wege.

Falls Sie Hilfe beim Einstieg benötigen, wenden Sie sich gern an unser Support-Team.