Sådan trigger du invitationer ved hjælp af Trustpilots API'er

Denne funktion er en del af Connect-tilkøbet.

Denne funktion er en del af Connect-tilkøbet, som er tilgængelig med pakkerne Premium og Advanced og er inkluderet i Enterprise-pakken.

Du kan bruge Trustpilots API'er til at trigge serviceanmeldelsesinvitationer, som sendes ud af Trustpilot. Denne artikel viser dig, hvordan du skal gøre.

Bemærk: Det kræver teknisk ekspertise.

Find din API key og secret key

Hvis du har adgang til API'er via din virksomhedskonto, kan du oprette og administrere dine API keys ved at følge vejledningen nedenfor eller gå direkte hertil.

  1. Gå ind på din virksomhedskonto > Integrationer > Udviklere > API'er.
  2. Navngiv din applikation, og angiv de domæner, du gerne vil inkludere, under Opret en ny applikation. Klik derefter på Opret applikation.
  3. Din nye applikation vises under Dine applikationer. Klik på rullemenuen eller navnet på din applikation for at udvide den og se din API key og secret key.

Find dit Business Unit ID (BUID)

Dit Business Unit ID er et unikt ID, der er specifikt for dit domæne. Det er altid det samme og ændrer sig kun, hvis dit domæne på Trustpilot bliver ændret. Du kan finde Business Unit ID'et for dit domæne ved hjælp af slutpunktet "Find a business unit". Den påkrævede parameter her er dit business units "name", dvs. dit websites domæne. Eksempel: Hvis du gerne vil finde Trustpilots BUID, skal du angive parameteren "trustpilot.com".

Du kan selv prøve det af. Du skal bare huske at angive en anden API key.

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

Når du får svar, skal du finde feltet "id". Dette er dit BUID for det domæne, du søgte efter.

Godkendelse med OAuth 2.0

Hvis du gerne vil kunne bruge et hvilket som helst privat API-slutpunkt på Trustpilot, kræves der godkendelse i form af et adgangstoken. Da det at trigge invitationer betragtes som et privat slutpunkt, vil målet være først at få et adgangstoken, som du kan genbruge til flere API calls, mens det er gyldigt. Når dit token er udløbet, kan du opdatere det. Du finder flere oplysninger i vores dokumentation om godkendelse her (på engelsk).

Ved integrationer på serversiden anbefaler vi, at du anvender Grant Type: Password.

Sådan trigger du en serviceanmeldelsesinvitation

Når først du har dit adgangstoken, kan du bruge vores API-slutpunkt "Create invitation(s)". Denne JSON-anmodning med API call skal indeholde kundens navn, e-mailadresse og et referencenummer, f.eks. et ordrenummer eller fakturanummer. Der er også nogle afsenderindstillinger, du kan tilpasse. Her er et eksempel på en JSON-anmodning:

    {
      "consumerEmail": "jens.hansen@eksempel.dk",
      "consumerName": "Jens Hansen",
      "referenceNumber": "inv00001",
      "replyTo": "jens.hansen@eksempel.dk",
      "locale": "da-DK",
      "senderEmail": "jens.hansen@eksempel.dk",
      "serviceReviewInvitation": {
      "preferredSendTime": "2013-09-07T13:37:00",
      "redirectUri": "https://eksempel.dk",
      "tags": [
        "tag1",
        "tag2"
      ],
      "templateId": "507f191e810c19729de860ea"
     },
      "locationId": "ABC123",
      "senderName": "Jens Hansen"
    }

Et vellykket API call vil sætte invitationer i kø til afsendelse på din virksomhedskonto, som du kan se under Invitationsstatus.

Hvis du udelader visse afsenderindstillinger såsom “senderEmail”, “templateId” eller “preferredSendTime”, gør det ikke noget – dette API-slutpunkt vil automatisk anvende indstillingerne i dine Invitationsindstillinger på din virksomhedskonto.

Valgfrie tags

Dette kan være nogle ekstra, specifikke data, som du har om kunden eller købet. Hvis du tilføjer dem, før anmeldelsen indsendes, vil den blive tagget med relevante data, som giver dig mulighed for at foretage en grundigere analyse og få en skræddersyet visning af anmeldelsen.

Gyldige tegn er a–z, A–Z, 0–9, understreg, tankestreg og punktum. Mellemrum er ikke tilladt.

URI-omdirigering

Med en redirect URI kan du omdirigere kunden til en webside, du selv vælger, når kunden har indsendt sin anmeldelse. Hvis du ikke angiver en redirect URI, føres kunden til Trustpilots side med bekræftelse på, at anmeldelsen er indsendt. Du kan også føre kunden tilbage til én af dine websider, som for eksempel din egen takkeside eller bare startsiden.

Sørg for at bruge hele URL'en, inklusive http eller https. For eksempel ville https://eksempel.dk være gyldig, mens eksempel.dk ikke ville være gyldig.

Hvis du vil vide mere om, hvordan du bruger Trustpilots godkendelse til private API'er, er denne artikel (på engelsk) sagen. 

Related articles