Nachdem Sie den API-Schlüssel erstellt haben, können Sie die API-Aufrufe einrichten. Sie können einen Anruf beispielsweise verwenden, um Teilnehmer zu einer Umfrage hinzuzufügen, Ergebnisse abzurufen oder z. B. abgemeldete E-Mail-Adressen zu bearbeiten.
Auf dieser Seite:
Einrichten eines API-Aufrufs für Entwickler
Einrichten eines API-Aufrufs für Entwickler
Auf der Übersichtsseite der API finden Sie eine Übersicht über die verfügbaren API-Aufrufe. Nachdem Sie den Aufruf ausgewählt haben, kann ein Entwickler/IT-Mitarbeiter aus Ihrer Organisation den Aufruf der API mit den folgenden Informationen einrichten:
- Wählen Sie auf der Übersichtsseite aus, welchen API-Aufruf Sie verwenden möchten.
- Fügen Sie die API-URL zu connect.crowdtech.com hinzu. Zum Beispiel erhalten Sie connect.crowdtech.com/api/v1/survey/surveys.
- Platzieren Sie den API-Schlüssel im Header des Aufrufs 'X-API-key'.
Übersicht der verfügbaren API-Aufrufe
Für Survey können Sie API-Aufrufe für verschiedene Komponenten einrichten, nämlich:
- Umfragen: Abrufen eines vollständigen Überblicks oder einer bestimmten Studie;
- Umfrageergebnisse; alle Ergebnisse einer Umfrage;
- Befragte: Hinzufügen oder Abrufen von Befragten;
- Übersetzungen von Umfragen: Frage- und Antworttexte mehrsprachiger Umfragen;
- Türsteher;
- Abmeldungen;
- Datenanreicherung.
Befragungen
GET /surveys: Eine Übersicht über die aktuellen Umfragen im Konto und deren Einstellungen.
GET /surveyId: Einstellungen einer Umfrage und die Statistiken in Bezug auf die Teilnahme.
Umfrageergebnisse
GET /results: Ruft die aggregierten Daten einer Umfrage ab.
Übersetzungen von Umfragen
GET /gettranslation: Übersicht über die Frage- und Antworttexte. Wenn Sie eine mehrsprachige Studie haben, sehen Sie sich die Ausgangstexte und die Übersetzungen an.
Antwortende
- ABRUFEN /Befragte
- GET /respondentId: Umfrageteilnehmer abrufen;
- POST /respondents: Hinzufügen von Befragten zu einer Umfrage;
- PATCH /enrichment: Aktualisieren der Datenanreicherung in einer Untersuchung;
- PATCH /respondents/unsubscribe: Hinzufügen von Abgemeldeten für alle Umfragen in einer Umgebung;
- PATCH /respondentId/unsubscribe: Fügen Sie einen Abbesteller hinzu.
Türsteher
GET /bouncers: Ruft Türsteher aus einer Untersuchung ab.
Abmeldung
GET /unsubscribes: Liste der abgemeldeten Befragten;
PATCH /: Schreibe die Befragten für alle Umfragen aus.
Datenanreicherung
PUT / Replace Datenanreicherung in der Forschung. Dies ist nur möglich, wenn noch keine Completes vorhanden sind.