API Dokumentation
Mit der re:spondelligent BI API können Sie Ihre Bewertungsdaten programmatisch abrufen und in Ihre eigenen Systeme integrieren – zum Beispiel für interne Dashboards, Reporting-Tools oder automatisierte Auswertungen.
Die API stellt drei Endpunkte zur Verfügung: Locations, Reviews und Sentiments. Zusammen bilden diese drei Endpunkte das vollständige Datenmodell ab, mit dem Sie Standorte, Bewertungen und Sentiment-Analysen verknüpfen können.
Authentifizierung
Die API verwendet Basic Authentication. Ihre Zugangsdaten (Benutzername und Passwort) erhalten Sie direkt von uns. Alle Anfragen werden gegen die folgende Base-URL gestellt:
https://app.respondelligent.com
Die drei Endpunkte
1. Locations
Liefert alle Standorte Ihres Accounts mit der jeweiligen Location-ID.
Endpunkt:
https://app.respondelligent.com/{ihr-account}/bi/location
2. Reviews
Liefert alle Bewertungen. Jede Review enthält eine Review-ID und eine Location-ID, sodass Sie die Zuordnung zum jeweiligen Standort herstellen können.
Endpunkt:
https://app.respondelligent.com/{ihr-account}/bi/review?filter[yearmonth]=yyyy-mm
3. Sentiments
Liefert die Sentiment-Analyse pro Review-ID. Eine Bewertung kann mehrere Sentiments enthalten, z.B. “Freundlichkeit”, “Sauberkeit” oder “Essen”. Jedes Sentiment hat ein Rating von 1 (schlecht) bis 5 (sehr gut), analog zur Sterne-Skala.
Endpunkt:
https://app.respondelligent.com/{ihr-account}/bi/sac?filter[yearmonth]=yyyy-mm
Datenmodell und Verknüpfung
Die drei Endpunkte sind über IDs miteinander verknüpft:
Location → hat eine Location-ID
Review → hat eine Review-ID und eine Location-ID (Zuordnung zum Standort)
Sentiment → hat eine Review-ID (Zuordnung zur Bewertung)
Empfohlener Ablauf
Schritt 1: Locations abrufen (nur nötig, wenn Sie mehr als einen Standort managen). Laden Sie über den Locations-Endpunkt alle Ihre Standorte. Damit erhalten Sie die Location-IDs als Referenz.
Schritt 2: Reviews abrufen. Holen Sie die Bewertungen über den Reviews-Endpunkt. Jede Bewertung enthält eine Location-ID, mit der Sie die Zuordnung zum jeweiligen Standort herstellen.
Schritt 3: Sentiments abrufen. Laden Sie die Sentiment-Daten über den Sentiments-Endpunkt. Verknüpfen Sie diese über die Review-ID mit der jeweiligen Bewertung und damit indirekt mit dem Standort.
Mit diesen drei Schritten können Sie Auswertungen erstellen wie z.B.: “10 Bewertungen haben sich im letzten Monat positiv über den Service geäussert” oder “Standort Zürich hat im Bereich Sauberkeit einen Durchschnitt von 4.2”.
Antwortformat
Alle Endpunkte liefern Daten im JSON-Format. Die Daten lassen sich direkt in gängigen Programmiersprachen und Tools weiterverarbeiten.
Fragen?
Falls Sie Fragen zur Integration haben oder Unterstützung bei der Einrichtung benötigen, kontaktieren Sie uns jederzeit unter [email protected].