Wie richte ich nach dem Update auf eTrusted meine API-Anbindung ein?

Wann solltest du die API-Umstellung durchführen?

Bevor du selbst tätig werden kannst, müssen von unserer Seite ein paar Voraussetzungen für eine erfolgreiche API-Umstellung geschaffen werden. Zunächst wird dein Kundenaccount (inklusive all deiner Shops) für die Produktivumgebung der neuen Bewertungsplattform eTrusted freigeschaltet. Zeitgleich werden wir ein API-Forwarding der bislang genutzten APIs von My Trusted Shops zu den neuen eTrusted APIs einrichten. Dadurch gewährleisten wir, dass du auch während der Phase, in denen du deine APIs umstellst, reibungslos Bewertungen sammeln, managen und in deinem Shop anzeigen kannst.

Sobald du von uns die Nachricht erhältst, dass dein Shop das Update auf eTrusted erhalten hat, ist der Zeitpunkt für die API-Umstellung gekommen. Führe nun die drei folgenden Schritte aus, um deine eTrusted APIs einzurichten:

1. Gehe in deinem eTrusted-Konto zum Bereich API Client Management, um deine API Client Credentials (Client ID und Client Secret) für die eTrusted-APIs zu erhalten. Bitte beachte: Dies ist nur möglich, wenn du über Adminrechte verfügst.
2. Finde mithilfe der Dokumentation unserer My Trusted Shops APIs heraus, welche API du bislang verwendet hast.
3. Folge der nachstehenden Anleitung und richte deine neue API-Anbindung ein.

Setup und Authentifizierung

Sobald du deine Logindaten für die eTrusted APIs von uns erhalten hast, kannst du dich gegenüber unserem Authorization Server authentifizieren. Unsere APIs sind via OAuth2 geschützt. Die Authentifizierung geschieht über einen initialen API-Call an den Authorization Server. Wie der initiale API-Call aussehen muss, erfährst du im Developer Center: Setup and Authentication

Sofern der API-Call erfolgreich war, erhältst du eine Antwort, die einen Access Token enthält. Dieser Access Token muss für alle nachfolgenden API-Calls im Request Header des Calls hinterlegt sein.

Umstellung der bisherigen ReviewRequest API zur neuen Questionnaire Link API

Mit der für My Trusted Shops bereitgestellten ReviewRequest API warst du in der Lage, Links zum Bewertungsfragebogen von Trusted Shops in individuell gestaltete Bewertungsanfragen einzubetten. Wenn du diese API bislang genutzt hast, ist die für eTrusted entwickelte Questionnaire Link API der passende Ersatz für diesen Use Case.

Über die Questionnaire Link API kannst du Links zu vorkonfigurierten Fragebögen für deine Kundinnen und Kunden bei eTrusted abrufen. Diese Links kannst du anschließend in eine E-Mail, SMS oder einen anderen Kommunikationskanal deiner Wahl integrieren, um auf diese Weise Kundenfeedback zu sammeln.

Damit du die Unterschiede zwischen der alten ReviewRequest API und der neuen Questionnaire Link API auf einen Blick erkennen kannst, stellen wir im Folgenden zwei beispielhafte API-Requests nebeneinander dar. Auf der linken Seite siehst du ein Beispiel für einen Request an die ReviewRequest API, auf der rechten Seite einen beispielhaften Request an die Questionnaire Link API.

System	My Trusted Shops	eTrusted
Auth	https://api.trustedshops.com/restricted/v2/shops/{tsId}/reviews/requests	https://api.etrusted.com/questionnaire-links
Path	HTTP Basic Auth (Username:Password)	OAuth2.0 Token, siehe Dokumentation
Body

Damit du die nötigen Einstellungen besser verstehst, erläutern wir dir nun die einzelnen Parameter. Zudem erfährst du, an welchen Stellen sich die Parameter der beiden API-Requests voneinander unterscheiden.

Wenn dein Request an die Questionnaire Link API erfolgreich war, erhältst du eine Antwort nach dem folgenden Muster:

{
 "id": "qre-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
 "link": "https://etru.st/imo2h79nl",
 "token": "eyJraWQiOiIvdG1wbHMvand0X3B1YmxpY19rZXkvZDRhMmQ2YjYtNzRjNS00NjZlLWI3M 
WQtNTQ1NTk4OGY0YjliIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.
eyJxdWVzdGlvbm5haXJ
lUmVmIjoicXJlLTdjMGJkNzM4LTM3NWItNDk4Ni05N2E2LTlhZjg2OThlMjRmMiIsImlzcyI6I
mh0dHBzOi8vd3d3LmV0cnVzdGVkLmNvbSIsImV2ZW50UmVmIjoiZXZ0LTBjYTk1MTU2L
WE5NDQtNDhlNC04Mjc1LTdlZGViMTY2MGUyYyIsInF1ZXN0aW9ubmFpcmVMb2NhbGUi
OiJlbl9HQiIsInN5c3RlbVZlcnNpb24iOiIxLjAuMCIsImF1ZCI6Imh0dHBzOi8vZmVlZGJhY2su
ZXRydXN0ZWQuY29tIiwicXVlc3Rpb25uYWlyZVRlbXBsYXRlUmVmIjoicXJ0LTRhNjFkN2J
mLTVkYTMtNDE4Yi1hOThmLWU2MDM1MzRkOWZkNV9lbi1HQiIsInN5c3RlbSI6ImN1c3R
vbWVyX3N5c3RlbV9uYW1lIiwiYXBpVmVyc2lvbiI6IjEuMS4wIiwiY29sbGVjdGlvblByb2Nlc3
MiOiJDTE9TRURfRkVFREJBQ0siLCJjaGFubmVsUmVmIjoiY2hsLTRiOTQxYjEzLWJiMDEt
NDBhOS1iZGZkLWE2ZjA0ZTVjYTEwZSIsImFjY291bnRSZWYiOiJhY2MtODYzYzlkOGQtM
TEwOC00NTkxLTg2OGQtNWUwYWFhZDI2Y2Y0IiwiaWF0IjoxNTM2NzY5NjQ3fQ.A8EZkvj
UEwFXT_U9bgVgIKfQkyxFY3K3G4YNN3tZzoc50eG1ggYsKzj-
_XLnN9tpDnyQXENFz4g8yY9kUK43LLvFxOHdWOjlF0X4ZPngyd4eSgBQTYyofeI39vKzc9
EPN9oajrqgog8jHMq4Y7oBa9Z2J4s21Q6N-hCp2vS128f5Wma12Wa9YExPV1Tf21P-
v5MMjYiqNan_oxX_3ENjJ07kzxP8SGN5QSbVUgZGmw6y213VDCGpopzm_cTkf67YKpW
n4wPNOeo_LDX5P6T85kyZC-F6g9R- uEFUtY_wBv1FrIBokfVfVQWJnbIajUjM21Z3_W5Am3JUyHxPcxnSMg"
}

Im Parameter link erhältst du den Link zum generierten Fragebogen. Diesen Link kannstdu nun in den Kommunikationskanal deiner Wahl integrieren.

Umstellung der bisherigen ReviewCollector API / ReviewTrigger API zur neuen Event API

Mit der für My Trusted Shops bereitgestellten ReviewCollector bzw. ReviewTrigger API warst du in der Lage, den Versand von Bewertungseinladungen an deine Kundschaft auszulösen. Deine Kundinnen und Kunden erhielten in diesem Fall eine von Trusted Shops versendete E-Mail mit einem Bewertungsfragebogen. Wenn du diese API bislang genutzt hast, ist die für eTrusted entwickelte Event API der passende Ersatz für diesen Use Case. Mit der Event API kannst du den Versandzeitpunkt für deine Bewertungseinladungen an jeden beliebigen Touchpoint entlang deiner Customer Journey koppeln.

Um dir die Unterschiede zwischen der alten ReviewCollector bzw. ReviewTrigger API und der neuen Event API möglichst übersichtlich darzustellen, präsentieren wir dir im Folgenden zwei beispielhafte API-Requests nebeneinander. Auf der linken Seite siehst du ein Beispiel für einen Request an die ReviewCollector bzw. ReviewTrigger API, auf der rechten Seite einen beispielhaften Request an die Event API.

System	My Trusted Shops	eTrusted
Path	https://api.trustedshops.com/restricted/v2/shops/{tsId}/reviewcollector	https://api.etrusted.com/event
Auth	HTTP Basic Auth (Username:Password)	OAuth2.0 Token, siehe Dokumentation
Body

Wir erklären dir nun die einzelnen Parameter, um dir die Unterschiede und die nötigen Einstellungen näherzubringen. Zudem erfährst du, an welchen Stellen sich die Parameter der beiden API-Requests voneinander unterscheiden.

Wenn dein Request an die Event API erfolgreich war, erhältst du eine Antwort nach dem folgenden Muster:

{
 "Message": "Your event (`evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx`) was accepted for processing.",
 "EventRef": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
}

Deine Kundin oder dein Kunde erhält daraufhin eine Bewertungseinladung.