Review API
Schnittstelle für die Integration von Kundenbewertungen
Für begrenzte Zeit für alle Pakete verfügbar
Schritte zur Verwendung der API
1. Generieren Sie einen API-Schlüssel
Um auf die API zuzugreifen, müssen Sie zunächst einen API-Schlüssel generieren. Folgen Sie diesen Schritten:
-
- Login: Melden Sie sich auf unserer Website mit Ihrem Konto an.
- Navigieren Sie zur Seite zur API-Schlüsselgenerierung
Gehen Sie nach der Anmeldung zur Seite „API-Schlüssel“. - API-Schlüssel generieren:
Klicken Sie auf die Schaltfläche Schlüssel generieren. - Bestätigen Sie durch Klick auf “Erzeugen”. (Das Generieren eines Schlüssels überschreibt vorhandene Schlüssel.)
Ihr eindeutiger API-Schlüssel wird angezeigt. Kopieren Sie diesen Schlüssel und bewahren Sie ihn sicher auf, da Sie ihn zur Authentifizierung Ihrer API-Anfragen benötigen.
Content-Type: application/json
x-api-key: <apiKey>2. Verwenden Sie den API-Schlüssel zur Authentifizierung und Autorisierung
Sobald Sie Ihren API-Schlüssel generiert haben, können Sie ihn zur Authentifizierung und Autorisierung Ihrer API-Anfragen verwenden.
Der API-Schlüssel gibt ein Unternehmen an und kann nur auf Bewertungen dieses bestimmten Unternehmens zugreifen.
Folgen Sie bitte diesen Schritten:
Fügen Sie den API-Schlüssel in Request Headers ein:
Wenn Sie eine Anfrage an die API stellen, fügen Sie den API-Schlüssel in die Header ein.
Der Header sollte wie im Beispiel auf der Linken Seite formatiert sein.
Ersetzen Sie bitte diesen Teil durch Ihren API Schlüssel:
<apiKey>3. API Dokumentation: Einrichtung der Schnittstelle
Weitere Informationen zu den verfügbaren API-Endpunkten und deren Verwendung finden Sie in der API-Dokumentation.
4. Endpunkte in den Dokumenten testen
Sie können die API-Endpunkte direkt auf der API-Dokumentationsseite testen, indem Sie die folgenden Schritte ausführen:
-
- Navigieren Sie zur API-Dokumentationsseite.
- Klicken Sie auf die Schaltfläche „Autorisieren“.
- Geben Sie Ihren API-Schlüssel ein:Kopieren Sie Ihren generierten API-Schlüssel und fügen Sie ihn in das dafür vorgesehene Eingabefeld für API-Schlüssel ein. Klicken Sie dann erneut auf “Autorisieren”.
Endpunkte erkunden und testen:
- Durchsuchen Sie die verfügbaren API-Endpunkte, die in der Dokumentation aufgeführt sind.
- Wählen Sie einen Endpunkt aus, den Sie testen möchten.
- Geben Sie alle erforderlichen Parameter ein und klicken Sie auf die Schaltfläche „Ausprobieren“, um die Anfrage auszuführen.
- Sehen Sie sich die Antwort direkt auf der Dokumentationsseite an, um die Ergebnisse Ihrer Anfrage zu sehen.
Hinweis: Bitte achten Sie auf die Schreibweise des Datums.
Bewertungen
