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

Wann sollte ich die API-Umstellung durchführen?

Bevor Sie selbst tätig werden können, müssen von unserer Seite ein paar Voraussetzungen für eine erfolgreiche API-Umstellung geschaffen werden. Zunächst wird Ihr Kundenaccount (inklusive all Ihrer 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 Sie auch während der Phase, in denen Sie Ihre APIs umstellen, reibungslos Bewertungen sammeln, managen und in Ihrem Shop anzeigen können.

Sobald Sie von uns die Nachricht erhalten, dass Ihr Shop das Update auf eTrusted erhalten hat, ist der Zeitpunkt für die API-Umstellung gekommen. Führen Sie nun die drei folgenden Schritte aus, um Ihre eTrusted APIs einzurichten:

1. Gehen Sie in Ihrem eTrusted-Konto zum Bereich API Client Management, um Ihre API Client Credentials (Client ID und Client Secret) für die eTrusted-APIs zu erhalten. Bitte beachten Sie: Dies ist nur möglich, wenn Sie über Adminrechte verfügen.
2. Finden Sie mithilfe der Dokumentation unserer My Trusted Shops APIs heraus, welche API Sie bislang verwendet haben.
3. Folgen Sie der nachstehenden Anleitung und richten Sie Ihre neue API-Anbindung ein.

Setup und Authentifizierung

Sobald Sie Ihre Logindaten für die eTrusted APIs von uns erhalten haben, können Sie sich 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, erfahren Sie im Developer Center: Setup and Authentication

Sofern der API-Call erfolgreich war, erhalten Sie 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 waren Sie in der Lage, Links zum Bewertungsfragebogen von Trusted Shops in individuell gestaltete Bewertungsanfragen einzubetten. Wenn Sie diese API bislang genutzt haben, ist die für eTrusted entwickelte Questionnaire Link API der passende Ersatz für diesen Use Case.

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

Damit Sie die Unterschiede zwischen der alten ReviewRequest API und der neuen Questionnaire Link API auf einen Blick erkennen können, stellen wir im Folgenden zwei beispielhafte API-Requests nebeneinander dar. Auf der linken Seite sehen Sie 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 Sie die nötigen Einstellungen besser verstehen, erläutern wir Ihnen nun die einzelnen Parameter. Zudem erfahren Sie, an welchen Stellen sich die Parameter der beiden API-Requests voneinander unterscheiden.

Wenn Ihr Request an die Questionnaire Link API erfolgreich war, erhalten Sie 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 erhalten Sie den Link zum generierten Fragebogen. Diesen Link können Sie nun in den Kommunikationskanal Ihrer 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 waren Sie in der Lage, den Versand von Bewertungseinladungen an Ihre Kundschaft auszulösen. Ihre Kundinnen und Kunden erhielten in diesem Fall eine von Trusted Shops versendete E-Mail mit einem Bewertungsfragebogen. Wenn Sie diese API bislang genutzt haben, ist die für eTrusted entwickelte Event API der passende Ersatz für diesen Use Case. Mit der Event API können Sie den Versandzeitpunkt für Ihre Bewertungseinladungen an jeden beliebigen Touchpoint entlang Ihrer Customer Journey koppeln.

Um Ihnen die Unterschiede zwischen der alten ReviewCollector bzw. ReviewTrigger API und der neuen Event API möglichst übersichtlich darzustellen, präsentieren wir Ihnen im Folgenden zwei beispielhafte API-Requests nebeneinander. Auf der linken Seite sehen Sie 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 Ihnen nun die einzelnen Parameter, um Ihnen die Unterschiede und die nötigen Einstellungen näherzubringen. Zudem erfahren Sie, an welchen Stellen sich die Parameter der beiden API-Requests voneinander unterscheiden.

Wenn Ihr Request an die Event API erfolgreich war, erhalten Sie 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"
}

Ihre Kundin oder Ihr Kunde erhält daraufhin eine Bewertungseinladung.