Uitnodigingen sturen met Business Generated Links
Deze handleiding is voor developers die Business Generated Links willen maken. Lees hoe je versleutelde links kunt maken in de programmeertaal van je voorkeur.
De uitnodigingsmethode Business Generated Links is alleen beschikbaar voor nieuwe zakelijke klanten in specifieke branches.
Trustpilot heeft hulpbronnen over geverifieerde versleuteling op GitHub waarmee je aan de slag kunt. Hier vind je meer informatie.
Handleiding voor alle programmeertalen
Business Generated Links maken gebruik van Authenticated Encryption with Associated Data (AEAD, geverifieerde versleuteling met gekoppelde gegevens) en een aanpak die Encrypt then MAC (EtM) wordt genoemd. Trustpilot gebruikt een sleutel voor de encryptie van de payload (encryptkey)
en een andere sleutel voor het MAC-deel (authkey)
om de betrouwbaarheid van de data te verzekeren.
Ga in Trustpilot Business naar Verzamel reviews > Uitnodigingsmethoden > Business Generated Links en zoek de twee sleutels.
Business Generated Links maken
-
De sleutels die je kopieert uit je Trustpilot Business-account, worden weergegeven in een
base64-encoded
-indeling. Je applicatie moet dus eerst de sleutelsbase64-decoderen
. -
Maak het JSON-geformatteerde
payloadobject
en voer de klantinformatie in. De volgende velden zijn verplicht: e-mailadres, naam en referentienummer. Hieronder zie je een voorbeeld:{ "email":"abc@domein.nl", "name":"Rob Smit", "ref":"1234", "skus":["sku1","sku2","sku3"], "tags":["tag1","tag2","tag3"] }
Tags mogen geen spaties bevatten.
-
Derden mogen de
payload
niet lezen. Daarom moet je depayload
versleutelen. Kies voor eenAES-CBC
-versleuteling met een sleutelgrootte van256 bits
, een blokgrootte van128 bits
en eenPKCS7-opvullingsmodus
.- Genereer een
Initialization Vector (IV)
in overeenstemming met de blokgrootte (128 bits
). - Codeer de JSON met de
encryptkey
en IV. - Maak een handtekening van de
ciphertext
. - Hiervoor gebruiken we HMAC-SHA256 en de
authkey
. Je berekent de HMAC door de IV tehashen
gevolgd door deciphertext
. Een voorbeeld:HMAC = HMAC-SHA256( IV + ciphertext )
- Genereer een
-
Codeer nu
base64-encode
the IV +ciphertext
+ HMAC. Zo ziet het eruit:base64_payload = base64( IV + ciphertext + HMAC )
-
Tot slot, omdat
base64
de slash (/) en plus (+) tekens bevat, is het nodig om vooraf depayload
te coderen metURL-codering
voordat je deze toevoegt aan de uiteindelijke link. -
Het eindresultaat moet er als volgt uitzien:
payload = urlencode( base64_payload ) https://www.trustpilot.com/evaluate-bgl/<domain>?p=<payload>
-
Vervang het
domein
door je domeinnaam en depayload
door de payload die je in stap 5 hebt gegenereerd.
Het volgende schema toont de stappen die nodig zijn om de payloadgegevens correct te formatteren, te coderen en voor te bereiden voordat deze worden overgedragen:
Een Business Generated Link verifiëren
Je kunt op twee manieren verifiëren of een Business Generated Link correct is gemaakt:
Test je link in een browser
Plak je link in een browser en klik op Enter. Maak vervolgens een testreview. Selecteer een sterrenscore, voer een titel en een tekst in voor de review. Als de knop Plaats review actief is, is het versleutelingsproces geslaagd. Wordt je gevraagd je aan te melden via Facebook, Google of e-mail, dan is het versleutelingsproces mislukt. Plaats je testreview niet.
Hier zie je links een voorbeeld van een geslaagd versleutelingsproces en rechts zie je een mislukt proces:
Test je link met onze command line interface (CLI)
Je kunt onze command line interface installeren op je development computer. Als je je payload met de CLI kunt decoderen, dan heb je je payload correct gecodeerd.
Vermijd het gebruik van generieke test-e-mailadressen (zoals test@gmail.com). Gebruik een uniek e-mailadres.
Business Generated Links coderen voor productreviews
Als je productreviews wilt verzamelen met Business Generated Links, voeg je product-SKU's toe aan je payload. Hieronder is een voorbeeld van een payload met product-SKU's. Dit is een eenvoudige JSON-matrix:
{ "email":"abc@domein.nl", "name":"Rob Smit", "ref":"1234", "skus":["sku1","sku2","sku3"] }
Een Business Generated Link lokaliseren voor een bepaald land
Om de link te lokaliseren, verwijder je 'www.' en vervang je het met een landcode. Bijvoorbeeld:
https://nl.trustpilot.com/evaluate-bgl/?p=
https://es.trustpilot.com/evaluate-bgl/?p=
Locatiereview-uitnodigingen sturen met Business Generated Links
Als je gebruikmaakt van Business Generated Links om je eigen review-uitnodigingen te sturen, moet je het locatieveld toevoegen wanneer je klantgegevens toevoegt aan het payload-object. Gebruik de locatie-ID die je aan de betreffende locatie hebt toegewezen.
Hieronder zie je een voorbeeld:
{ "email":"abc@domein.nl", "name":"Rob Smit", "ref":"1234", "locationId": "id1", "skus":["sku1","sku2","sku3"], "tags":["tag1","tag2","tag3"] }
De locatie-ID is hoofdlettergevoelig.