Wil je een aangepaste TrustBox-widget maken om je Trustpilot-reviews en scores op je website weer te geven? Dit kan met onze API's. Hier lees je hoe je dit aanpakt.
Voor deze configuratie is wat technische kennis vereist. Wellicht kun je je developer hiervoor om hulp vragen.
Business Units
Voordat je je Trustpilot-reviews gaat tonen, is het belangrijk om te weten hoe we domeinen identificeren via Business Unit ID's, of BUID's. De Business Unit is de plek waar alle Trustpilot-inhoud voor een website wordt verzameld. Met andere woorden, de Business Unit bevat de score, reviews en reacties van een bedrijf. De BUID is een unieke identificatie voor die Business Unit en de primaire sleutel bij veel van je API-calls. Hier lees je meer over BUID's.
Een 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 Business Unit, 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 veld 'id'. Dit is de BUID van het domein waarnaar je zojuist hebt gezocht.
Reviews ophalen
Zodra je de BUID van je bedrijf hebt, kun je reviews, scores en reacties op reviews ophalen met de API-call Get a business unit’s reviews.
Als je alleen de openbare info over de Business Unit wilt (oftewel de sterrenscore, het aantal reviews, de TrustScore, enz.), vind je de gegevens in het hierboven genoemde eindpunt Find a business unit. Ook kun je Get public business unit gebruiken.
Richtlijnen voor aangepaste integratie
Om ervoor te zorgen dat je aan onze richtlijnen voldoet, raden we aan ons gedetailleerde ondersteunende document te lezen op Trustpilot API's - Richtlijnen voor integratie van bedrijfsreviews.
Een paar belangrijke conclusies:
- Je moet altijd aangeven welke reviews je laat zien. Als je bijvoorbeeld 4- en 5-sterrenreviews toont, moet je dit aangeven.
- Maak de API-sleutel niet bekend in de front-end. Voer alleen API-calls uit via de back-end en geef vervolgens de gegevens door naar de front-end voor weergave.
- Omdat we snelheidsbeperkingen willen voorkomen, voer je geen API-call uit telkens wanneer de pagina laadt. Voeg de gegevens toe aan de cache en update deze elke 30 minuten/1 uur/24 uur. Je kunt ook onze webhooks gebruiken om reviews in realtime bij te werken.
- Google mag de tekst van je widget-review niet kunnen indexeren. Zo vermijden we boetes voor dubbele content die nadelig zijn voor je zoekmachine-rankings. Host in plaats daarvan je widgets op een aparte pagina (bijv. een subdomein) waar je een tag <meta name="robots" content="noindex"> in de kop hebt. Hier kun je een <iframe> gebruiken om de TrustBox-widget op je hoofdsite te tonen.
API-calls aan de serverzijde
Alle API-calls moeten voor de beveiliging aan de serverzijde worden uitgevoerd. Hierdoor wordt je API-privésleutel niet blootgesteld op je website. Ook kan de pagina sneller worden geladen en nemen de netwerkkosten af.
Calls aan de cache toevoegen
Als je aangepaste TrustBox-widgets op je site weergeeft, raden we aan de gegevens aan de cache toe te voegen. Zo verbeter je de prestaties en betrouwbaarheid. De prestaties worden verbeterd omdat de herkomst van de gegevens in de cache dichter bij de consument zijn en omdat de cache dubbele verzoeken om gegevens kan verwerken, wat onnodige berekeningen en netwerkverkeer voorkomt. De betrouwbaarheid neemt toe omdat de consument van de gegevens geen serviceonderbrekingen van de herkomst ondervindt.