So generieren Sie Einladungslinks mithilfe von Trustpilot-APIs

Dieses Feature ist Teil des Connect-Add-ons.

Holen Sie sich das Modul

Sie können eine Trustpilot-API verwenden, um Einladungslinks zu generieren. Diese Einladungslinks können Sie dann in Ihren eigenen E-Mails oder über einen anderen Kommunikationsweg an Ihre Kunden senden. In dieser Anleitung erfahren Sie, wie Sie mithilfe einer Trustpilot-API einmalige Einladungslinks generieren.

Bitte beachten: Hierfür benötigen Sie ggf. die Hilfe eines Entwicklers.

So finden Sie Ihren API-Schlüssel und Ihren geheimen Schlüssel

Wenn Ihr Account Zugriff auf APIs hat, können Sie Ihre API-Schlüssel erstellen und verwalten, indem Sie hier diesen Schritten folgen:

  1. Gehen Sie in Ihrem Trustpilot-Business-Account zum Bereich Integrationen, dort zu Entwickler und weiter zu APIs.
  2. Geben Sie unter Neue Anwendung erstellen einen Namen für Ihre Anwendung ein sowie alle Domains, die Sie einbeziehen möchten. Klicken Sie auf Anwendung erstellen.
  3. Ihre Anwendung wird nun in der Liste Ihre Anwendungen angezeigt. Klicken Sie auf den Pfeil neben Ihrer Anwendung, um die Details zur Anwendung mit Ihrem API-Schlüssel und Ihrem geheimen Schlüssel zu öffnen.

So finden Sie Ihre Business-Unit-ID (BUID)

Ihre Business-Unit-ID ist ein eindeutiger Identifikator, der Ihrer Domain zugeordnet ist. Sie ist statisch und ändert sich nur, wenn sich Ihre Domain auf Trustpilot ändert. Um die BUID Ihrer Domain zu finden, müssen Sie unseren API-Endpunkt „Find a business unit“ verwenden. Dafür ist der Parameter „Name“ der Business-Unit erforderlich, d. h. die Domain Ihrer Website. Ein Beispiel: Wenn Sie auf der Suche nach der BUID von Trustpilot wären, würden Sie als Parameter „trustpilot.com“ verwenden.

Probieren Sie es einfach selbst aus. Denken Sie nur daran, den API-Schlüssel und den Domainnamen zu ersetzen:

https://api.trustpilot.com/v1/business-units/find?apikey={{apikey}}&name=trustpilotdemo.com

Suchen Sie in der Antwort nach dem „ID“-Feld. Diese ID ist die Business-Unit-ID der Domain in Ihrer Suche.

Authentifizierung mit OAuth 2.0

Um einen privaten API-Endpunkt auf Trustpilot zu verwenden, ist eine Authentifizierung mittels eines Zugriffstokens erforderlich. Da die Generierung von Einladungslinks einen privaten Endpunkt darstellt, müssen Sie sich zuerst ein Zugriffstoken beschaffen. Dieses können Sie dann, solange es gültig ist, für mehrere API-Aufrufe wiederverwenden. Sobald das Token abläuft, können Sie es aktualisieren. In unserem Handbuch für Entwickler finden Sie weitere Informationen zur Authentifizierung.

Bitte beachten: Für serverseitige Integrationen empfehlen wir, den Gewährungstyp „Password“ zu verwenden.

So generieren Sie einen Einladungslink für Servicebewertungen

Sobald Sie über Ihr Zugriffstoken verfügen, können Sie unseren API-Endpunkt „Generate service review invitation link“ verwenden. Diese JSON-Anfrage für den API-Aufruf erfordert den Kundennamen, die E-Mail-Adresse, den Lokalisierungs-Code und irgendeine Art von Referenz-ID wie beispielsweise eine Bestell- oder Rechnungsnummer. Hier ein komplettes Beispiel für eine JSON-Anfrage:

    {
        "referenceId": "rech00001",
        "name": "Max Mustermann",
        "tags": [
          "Tag1", 
          "Tag2"
        ],
        "locale": "de-DE",
        "email": "m.mustermann@trustpilot.de", 
        "redirectUri": "https://www.trustpilot.de"
    }

Der API-Aufruf gibt einen einmaligen Einladungslink zurück, den Sie direkt an den jeweiligen Kunden senden können.

Sicher sind Ihnen in der Anfrage die Felder für optionale Tags und die Umleitungs-URI aufgefallen. Zum besseren Verständnis hier ein Überblick über diese beiden Felder:

Optionale Tags

Hierbei handelt es sich um zusätzliche Daten, die Ihnen über Ihre Kunden oder deren Käufe vorliegen. Indem Sie diese Daten in den Einladungslink einbeziehen, d. h. bevor die Bewertung abgegeben wird, werden Ihre Bewertungen mit extrem relevanten Daten versehen, was eine detailgenauere Analytik und die noch gezieltere Präsentation von Bewertungen ermöglicht.

Zulässige Zeichen sind a–z, A–Z, 0–9, Unterstrich, Gedankenstrich und Punkt. Leerzeichen sind nicht zulässig.

Umleitungs-URI

Mit einer Umleitungs-URI können Sie Ihre Kunden, sobald sie ihre Bewertung abgeben, auf jede Webseite Ihrer Wahl umleiten. Wenn Sie die Umleitungs-URI weglassen, werden die Bewerter zu einer Trustpilot-Seite weitergeleitet, welche die Abgabe der Bewertung bestätigt. Wenn Sie die Bewerter stattdessen zu einer Seite auf Ihrer Website umleiten möchten (z. B. zu Ihrer eigenen „Danke“-Seite oder einfach zu Ihrer Startseite), dann haben Sie mit diesem Feld die volle Kontrolle hierüber.

Stellen Sie sicher, dass Sie eine vollständige URL mit http/https verwenden (https://beispiel.de wäre gültig, aber beispiel.de nicht).