Uitnodigingen activeren met Trustpilots API's

Deze functie maakt deel uit van de add-on Connect.

Met Trustpilot-API's kun je review-uitnodigingen activeren die door Trustpilot worden verzonden. Hier lees je hoe je deze instelt.

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 activeren van uitnodigingen als een privé-eindpunt wordt beschouwd, moet je eerst een toegangstoken krijgen, dat je vervolgens opnieuw kunt gebruiken 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 activeren

Zodra je je toegangstoken hebt, kun je ons API-eindpunt 'Create invitation(s)' gebruiken. Dit JSON-verzoek voor een API-call vereist de naam van de klant, het e-mailadres en een referentienummer van de klant, zoals een bestelnummer of factuurnummer. Ook zijn er enkele afzenderopties die je kunt aanpassen. Hier is een voorbeeld van een JSON-verzoek:

    {
      "consumerEmail": "jan.smit@trustpilot.nl",
      "consumerName": "Jan Smit",
      "referenceNumber": "inv00001",
      "replyTo": "jan.smit@trustpilot.nl",
      "locale": "nl-NL",
      "senderEmail": "jan.smit@trustpilot.nl",
      "serviceReviewInvitation": {
      "preferredSendTime": "2013-09-07T13:37:00",
      "redirectUri": "http://trustpilot.nl",
      "tags": [
        "tag1",
        "tag2"
      ],
      "templateId": "507f191e810c19729de860ea"
     },
      "locationId": "ABC123",
      "senderName": "Jan Smit"
    }

Bij geslaagde API-calls worden uitnodigingen aan een wachtrij toegevoegd in Trustpilot Business. Je kunt ze bekijken door in te loggen op je account en naar je uitnodigingsgeschiedenis te gaan.

Je kunt bepaalde opties voor afzenders, zoals 'senderEmail', 'templateId' of 'preferredSendTime' gewoon weglaten. Dit API-eindpunt maakt automatisch gebruik van de instellingen die zijn ingeschakeld in je Uitnodigingsinstellingen van Trustpilot Business.

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