Bewertungs-API

Steuern Sie Einladungen und Bewertungen über Ihr eigenes Backend

Erstellen Sie einen vertraulichen OAuth-Client mit den erforderlichen Berechtigungen und automatisieren Sie Einladungen, Widgets und Bewertungsabläufe von Server zu Server. Alles, was der Unternehmensbereich bietet, steht auch Ihrem eigenen Code zur Verfügung.

(wird in einem neuen Tab geöffnet)Jetzt verfügbar
Derzeit kostenlos nutzbar
Alle Funktionen inklusive
In 2 Minuten eingerichtet

Was zwischen den beiden Systemen übertragen wird

Ihr BackendRuft die API mit einem OAuth-Client mit begrenztem Berechtigungsumfang auf
WebVouchEinladungen, Vorlagen, Widgets und Bewertungen
Antworten und WebhooksDie angeforderte Antwort sowie Ereignisse, sobald Bewertungen eingehen
Was löst es aus
Ihr eigener Code ruft die API auf.
Was WebVouch erhält
Was auch immer die Anfrage enthält: Einladungen, Widget-Konfiguration, Bewertungsabfragen.
Was an API zurückgesendet wird
Die vom Aufruf angeforderte Antwort. Kombinieren Sie sie mit Webhooks, wenn Sie auch über neue Bewertungen benachrichtigt werden möchten.

Was die API-Integration leistet

  • Erstellen Sie benannte serverseitige OAuth-Clients mit festgelegten Berechtigungsumfängen.

  • Automatisieren Sie Einladungs-, Widget- und Bewertungsabläufe über Ihre Systeme.

  • Nutzen Sie die öffentliche OpenAPI-Beschreibung und serverseitige Beispiele.

So richten Sie es ein

3 Schritte in der Reihenfolge, in der Sie sie ausführen. Die Verbindung finden Sie in Ihrem Unternehmensbereich.

  1. 1

    Erstellen Sie einen Client

    Fügen Sie im Unternehmensbereich einen vertraulichen OAuth-Client hinzu, benennen Sie ihn nach dem System, das ihn verwenden wird, und bewahren Sie die Zugangsdaten auf Ihrem Server auf.

  2. 2

    Erteilen Sie nur die benötigten Berechtigungen

    Beschränken Sie jeden Client auf die Aufgaben, die er erledigt. Ein Dienst, der nur Einladungen versendet, muss keine Moderationsdaten lesen können.

  3. 3

    Rufen Sie die API auf

    Folgen Sie der öffentlichen OpenAPI-Beschreibung. Ergänzen Sie sie durch Webhooks, wenn Sie auch auf neu eingehende Bewertungen reagieren möchten.

Wann API die richtige Wahl ist

Wählen Sie die API, wenn kein Plugin den Verkauf erfassen kann, zum Beispiel bei einer telefonischen Bestellung, einem zweiten Vertriebskanal oder einer Buchung, die eine Person bestätigt. Bei einem einfachen Shop-Checkout ist die Shop-Integration mit weniger Aufwand verbunden und wartungsfrei.

Die Reviews-API im Detail

Drei Dinge, die Sie wissen sollten, bevor Sie den ersten API-Aufruf tätigen. Jedes davon gilt auch für die Referenzdokumentation, die Sie ohne Konto lesen können.

  1. 01

    Server-zu-Server-Kommunikation mit Clients mit eingeschränkten Berechtigungen

    Die Authentifizierung erfolgt über einen vertraulichen OAuth-Client, den Sie im Unternehmensbereich erstellen. Dabei handelt es sich um Zugangsdaten für die serverseitige Verwendung, die daher weder in einen Browser noch in eine mobile App gehören. Jeder Client ist auf die Aufgaben beschränkt, für die er vorgesehen ist: Ein Dienst, der ausschließlich Einladungen versendet, erhält nur die Berechtigung zum Versenden von Einladungen und sonst keine. Auf Moderationsdaten, für die er keine Berechtigung erhalten hat, kann er nicht zugreifen.

  2. 02

    Was Sie automatisieren können

    Achtundzwanzig Endpunkte decken Einladungen, Vorlagen, Widgets und Bewertungen ab – damit können Sie alles, was der Unternehmensbereich bietet, mit Ihrem eigenen Code umsetzen. Die öffentliche OpenAPI-Beschreibung ist maschinenlesbar. So können Sie einen typisierten Client generieren, anstatt einen von Hand zu schreiben. Die Schnellstartanleitung führt Sie durch den ersten API-Aufruf, bevor Sie sich für irgendetwas anmelden.

  3. 03

    Wann die API einem Plugin überlegen ist

    Ein Shop-Plugin sieht nur die Bestellungen dieses Shops. Die API deckt auch Vorgänge ab, die der Shop nicht erfasst: eine telefonische Bestellung, einen zweiten Vertriebskanal oder eine Buchung, die jemand manuell bestätigt. Nutzen Sie die API zusätzlich zu einem Plugin statt als Ersatz dafür. Kombinieren Sie sie mit Webhooks, wenn Ihr System auch über neue Bewertungen informiert werden soll.

Lesen Sie die Integration von API, bevor Sie sie installieren

Links führen von der Website weg und werden in einem neuen Tab geöffnet.

Fragen zur API-Integration

Über vertrauliche OAuth-Clients, die im Unternehmensbereich erstellt werden. Dabei handelt es sich um serverseitige Zugangsdaten, die daher niemals in einen Browser oder eine mobile App gehören.

Integrationsdetails zuletzt aktualisiert am

Bewertungen, um die Sie nie gebeten haben sind Bewertungen, die Sie nie erhalten haben.

Die meisten Kundinnen und Kunden schreiben auf Nachfrage einmal über einen Kauf – wenn der Zeitpunkt stimmt. Eine Integration macht aus einer Aufgabe, an die jemand denken muss, einen automatischen Vorgang.

Wir verwenden Cookies. Wir verwenden notwendige Cookies, um WebVouch zu betreiben, und Google Analytics nur, wenn Sie dies erlauben. Datenschutzerklärung