Uitnodigingslinks genereren met Trustpilots API's

Voor deze functie is de Connect-module vereist, die als uitbreiding kan worden aangeschaft voor de pakkettenPremium en Advanced en is inbegrepen in het Enterprise-pakket.

Je kunt een Trustpilot-API gebruiken om uitnodigingslinks te maken. Deze kunnen worden verzonden via je eigen e-mails of elke andere methode waarmee je met je klanten communiceert. Lees hier hoe je unieke uitnodigingslinks kunt genereren via een Trustpilot-API.

Mogelijk heb je hierbij hulp van een developer nodig.

Je API en geheime sleutel vinden

Als je account API-toegang heeft, kun je je API-sleutels maken en beheren door de onderstaande stappen te volgen of door rechtstreeks naar deze pagina te gaan.

  1. Ga in je Trustpilot Business-account naar Integraties > Developers > Trustpilot API's.
  2. Voer, onder Creëer een nieuwe applicatie, een naam voor je applicatie in en de domeinen die je wilt gebruiken. Klik op Creëer applicatie.
  3. Je nieuwe applicatie staat nu in de lijst Je applicaties. Klik op het dropdown-menu om de applicatie te bekijken en je API- en geheime sleutel te vinden.

Je Business Unit-ID (BUID) vinden

Je Business Unit-ID is een unieke ID die specifiek is voor je domein. Het is statisch en verandert alleen als je domein op Trustpilot verandert. Om de BUID van je domein te vinden, gebruik je het eindpunt 'Find a business unit'. De vereiste parameter hier is de 'naam' van de bedrijfseenheid, oftewel het domein van je website. Als je bijvoorbeeld op zoek bent naar Trustpilots BUID, voer je 'trustpilot.com' in.

Je kunt dit voorbeeld zelf uitproberen, maar vergeet niet de API-sleutel te vervangen.

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

Zodra je een reactie krijgt, zoek je het 'id'-veld. Dit is de BUID van het domein waarnaar je zojuist hebt gezocht.

Authenticatie met OAuth 2.0

Om een ​​privé-API-eindpunt op Trustpilot te gebruiken, is authenticatie met een toegangstoken vereist. Aangezien het maken van uitnodigingslinks als een privé-eindpunt wordt beschouwd, moet je eerst een toegangstoken verkrijgen, dat je vervolgens kunt hergebruiken voor meerdere API-calls (zolang deze geldig is). Wanneer het is verlopen, kun je het token bijwerken. Meer informatie hierover vind je in onze authenticatie-documentatie.

Voor server-side-integraties raden we aan om Grant Type: Password te gebruiken.

Een bedrijfsreview-uitnodiging maken

Zodra je je toegangstoken hebt, kun je ons API-eindpunt 'Generate service review invitation link' gebruiken. Dit JSON-verzoek voor een API-call vereist de naam van de klant, het e-mailadres, de locatiecode en een referentienummer van de klant, zoals een bestelnummer of factuurnummer. Hier is een volledig JSON-verzoek als voorbeeld:

    {
        "referenceId": "inv00001",
        "name": "Janneke Smit",
        "tags": [
          "tag1", 
          "Tag2"
        ],
        "locale": "nl-NL",
        "email": "janneke.smit@nl.trustpilot.com", 
        "redirectUri": "http://nl.trustpilot.com"
    }

De API-call retourneert een eenmalige uitnodigingslink die je rechtstreeks naar je klanten kunt sturen.

Je zult ook optionele tags en redirectUri-velden in het verzoek zien. Hier is een overzicht dat je kan helpen ze beter te begrijpen:

Optionele tags

Dit zijn aanvullende specifieke gegevens die je hebt over je klanten of hun aankopen. Door deze gegevens toe te voegen voordat de review wordt verzonden, worden je reviews voorzien van uiterst relevante data, wat zorgt voor meer gedetailleerde analyses en een nog meer op maat gemaakte weergave van reviews.

Geldige tekens zijn a-z, A-Z, 0-9, onderstrepingstekens, koppeltekens en punten. Spaties zijn niet toegestaan.

Redirect URI

Met een redirectUri (omleidings-URI) kun je klanten doorsturen naar elke gewenste webpagina nadat ze hun review hebben geplaatst. Door de redirectUri weg te laten, worden reviewers naar een Trustpilot 'review ingediend'-pagina gebracht. Je kunt ze ook naar een aangepaste pagina van je website sturen, bijvoorbeeld een bedankpagina, of simpelweg je homepagina.

Zorg ervoor dat je de volledige URL gebruikt inclusief http of https ('https://voorbeeld.nl' is een geldige URL, 'voorbeeld.nl' is niet geldig).

Related articles