Så här skapar du inbjudningar med hjälp av Trustpilots API:er

Denna funktion ingår i tilläggsmodulen Connect.

Skaffa modulen

Du kan använda dig av Trustpilots API för att skapa företagsomdömesinbjudningar som ska skickas ut av Trustpilot. Här kan du läsa om hur du gör.

Obs: Du kan behöva be en utvecklare om hjälp med detta.

Hitta API-nyckel och hemlig nyckel

Om ditt konto tillåter API-åtkomst kan du skapa och hantera dina API-nycklar genom att följa nedanstående steg, eller genom att gå direkt hit.

  1. Logga in på ditt företagskonto och gå till till Integrationer > Utvecklare > Trustpilots API:er.
  2. Under Skapa en ny applikation namnger du din applikation och anger de domäner som du vill inkludera. Klicka på Skapa applikation.
  3. Du hittar applikationen under Dina applikationer. Klicka på applikationen i menyn för att visa uppgifterna och hitta din API-nyckel samt den hemliga nyckeln.

Hitta Business Unit ID (BUID)

Ditt Business Unit ID är ett unikt ID som är specifikt för din domän. Detta ID är statiskt och ändras endast ifall din domän på Trustpilot ändras. Du kan hitta din domäns Business Unit ID med hjälp av slutpunkten "Find Business Unit". Parametern som krävs här är "namnet" på din Business Unit, dvs. domänen för din webbplats. Om du exempelvis vill hitta Trustpilots BUID anger du strängen "trustpilot.com".

Testa själv – men kom ihåg att ange en annan API-nyckel.

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

När du får svar letar du fram fältet "id". Detta är ditt BUID för domänen du sökt efter.

Autentisering med OAuth 2.0

För att kunna använda en privat API-slutpunkt på Trustpilot krävs autentisering i form av en åtkomsttoken. Att skapa inbjudningslänkar klassas som en privat slutpunkt och därför behöver du först få en åtkomsttoken, som du därefter kan använda för flera API-anrop medan den är giltig. När din token löpt ut kan du uppdatera den. Du kan läsa mer om detta i vår autentiseringsdokumentation.

Obs: Vid integrationer på serversidan rekommenderar vi att du använder Grant Type: Password.

Skapa en företagsomdömesinbjudan

När du väl har din åtkomsttoken kan du använda vår API-slutpunkt "Create invitation(s)". Denna JSON-begäran med API-anrop kräver kundnamnet, e-mailadressen och ett referensnummer, som till exempel ett ordernummer eller fakturanummer. Det finns också ett antal avsändarinställningar som du kan anpassa. Här är ett exempel på en JSON-begäran:

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

Framgångsrika API-anrop kommer att ställa inbjudningar i kö på ditt företagskonto. Dessa kan du se genom att logga in på ditt konto och titta på din Inbjudningshistorik.

Obs: Om du utelämnar vissa avsändarinställningar så som “senderEmail”, “templateId”, eller “preferredSendTime” gör det inget – denna API-slutpunkt kommer då automatiskt använda inställningarna som finns i dina inbjudningsinställningar på ditt företagskonto.

Valfria taggar

Valfria taggar kan vara utökade, specifika data som du har om kunden eller köpet. Genom att lägga till valfria taggar innan det att omdömet publiceras kan omdömet taggas med relevanta data, vilket kan underlätta analys och ge dig större möjligheter att anpassa hur omdömet visas upp.

Giltiga tecken är a-z, A-Z, 0-9, understreck, bindestreck och punkt. Mellanslag är inte tillåtna.

URI-omdirigering

Med en redirektUri kan du ange en webbsida som kunden omdirigeras till efter det att omdömet lämnats. Om du inte anger redirectUri skickas omdömeslämnare vidare till Trustpilots sida som bekräftar att omdömet lämnats. Du kan välja att omdirigera kunden till en specifik sida på din sajt såsom startsidan eller en tack-sida.

Kom ihåg att ange en fullständig URL inklusive http/https (https://exempel.se är fullständig, till skillnad från exempel.se).

Var denna artikel till hjälp?