Nachdem Sie den API-Schlüssel erstellt haben, können Sie API-Aufrufe einrichten. Sie können zum Beispiel einen Aufruf verwenden, um Teilnehmer zur Community hinzuzufügen, Teilnehmer abzumelden oder Hintergrundinformationen eines Community-Teilnehmers zu aktualisieren.
Auf dieser Seite:
Einrichtung von API-Aufrufen für Entwickler
Überblick über API-Aufrufe
Umfragen
Umfrageergebnisse
Übersetzungen von Umfragen
Einrichten eines API-Aufrufs für Entwickler
Die API-Übersichtsseite bietet einen Überblick über die verfügbaren API-Aufrufe. Nach Auswahl des Aufrufs kann ein Entwickler/IT-Mitarbeiter Ihrer Organisation den API-Aufruf mit den folgenden Informationen einrichten:
- Wählen Sie auf der Übersichtsseite den API-Aufruf, den Sie verwenden möchten.
- Fügen Sie die API-Url zu connect.crowdtech.com hinzu. Sie erhalten z.B. connect.crowdtech.com/api/v1/survey/surveys.
- Setzen Sie den API-Schlüssel in den Header des Aufrufs 'X-API key'.
Übersicht der verfügbaren API-Aufrufe
Für Community können Sie API-Aufrufe für verschiedene Komponenten einstellen, nämlich:
- Profile
- Profil-Variablen
- Türsteher
Profile
- GET /profiles: Abrufen der Profile in einer Liste
- POST /profiles: Hinzufügen von einem oder mehreren neuen Profilen/Teilnehmern
- PATCH /profiles: Aktualisierung der Informationen eines oder mehrerer Profile in der Community
- DELETE /profiles: ein oder mehrere Profile aus der Community löschen. Achtung, dies löscht alle Daten dieses Teilnehmers
- GET /profiles /profileID: Abrufen eines Profils
- PATCH /profiles /unsubscribe: meldet Profile aus der Community ab. Sie können danach nicht mehr kontaktiert werden.
Profil-Variablen
- GET /variables: Abruf der vorhandenen Profilvariablen und der Variablenoptionen dieser Community
- POST /variables: Hinzufügen einer oder mehrerer neuer Profilvariablen und Variablenoptionen zu dieser Community
- PATCH /variables: Aktualisierung der bestehenden Profilvariablen und Variablenoptionen in dieser Community
- DELETE /variables: löscht eine oder mehrere Profilvariablen oder Variablenoptionen aus dieser Community
Türsteher
- GET /bouncers: Abrufen von Bouncern aus einer Umfrage.