Quand dois-je effectuer la conversion des API ?
Avant que vous puissiez agir vous-même, nous déterminerons quelques conditions préalables afin d’assurer une conversion API réussie. Tout d'abord, votre compte client (y compris toutes vos boutiques) sera activé pour l'interface de la nouvelle plateforme d'évaluation eTrusted. Dans le même temps, nous mettrons en place un transfert d'API des API utilisées jusqu'à présent par My Trusted Shops vers les nouvelles API d'eTrusted. Vous pourrez ainsi continuer à collecter, gérer et afficher les avis dans votre boutique pendant la conversion de vos API.
Dès que vous recevez le message de notre part indiquant que votre boutique a reçu la mise à jour vers eTrusted, le moment est venu de procéder à la conversion des API. Suivez maintenant les trois étapes ci-dessous pour configurer vos API eTrusted:
- Dans votre compte eTrusted dans la section API Client Management pour obtenir vos API Client Credentials (Client ID und Client Secret) pour les API eTrusted. Veuillez noter : Cela n'est possible que si vous disposez des droits d'administrateur.
- Pour découvrir quelle API vous avez utilisée jusqu'à présent, suivez le lien suivant: Documentation de nos API My Trusted Shops.
- Suivez les instructions ci-dessous pour configurer votre nouvelle connexion API.
Configuration et authentification
Dès que vous aurez reçu de notre part vos données de connexion pour les API eTrusted, vous pourrez vous authentifier auprès de notre serveur d'autorisation. Nos API sont protégées par OAuth2. L'authentification se fait à travers un appel initial des API au serveur d'autorisation. Découvrez à quoi devra ressembler l'appel initial des API dans le Centre des développeurs : Setup and Authentication
Si l'appel API a réussi, vous recevrez une réponse contenant un jeton d'accès appelé « token ». Ce token doit être stocké dans l'en-tête de la demande d’appel pour tous les appels API ultérieurs.
Conversion de l'ancienne API ReviewRequest vers la nouvelle API Questionnaire Link
Avec l'API fournie pour My Trusted Shops API ReviewRequest, vous avez pu intégrer des liens vers le questionnaire d’évaluation de Trusted Shops dans des demandes d’avis personnalisées. Si vous avez utilisé cette API jusqu'à présent, l'API Questionnaire Link développée pour eTrusted représente l’API de remplacement appropriée pour ce cas d'utilisation.
Grâce à l'API Questionnaire Link, vous pouvez récupérer des liens vers des questionnaires préconfigurés pour vos clients sur eTrusted. Vous pouvez ensuite intégrer ces liens dans un e-mail, un SMS ou un autre canal de communication de votre choix pour recueillir les retours clients.
Pour vous aider à voir d'un coup d'œil les différences entre l'ancienne API ReviewRequest et la nouvelle API Questionnaire Link, nous vous présentons ci-dessous deux exemples de requêtes API côte à côte. À gauche, vous pouvez voir un exemple de demande à l'API ReviewRequest; à droite, un exemple de demande à l'API Questionnaire Link.
| Système | 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, documentation |
| Body |
Pour vous aider à comprendre les réglages nécessaires, nous allons maintenant préciser les différents paramètres. Vous pouvez également découvrir où les paramètres des deux requêtes API diffèrent l'un de l'autre.
| Paramètres API ReviewRequest |
Paramètres API Questionnaire Link | Différences | Explication |
| tsid | channel.id | Des informations nouvelles / supplémentaires doivent être fournies. | L'ancien paramètre tsid n'est plus requis pour l'API Questionnaire Link. Au lieu de cela, chacun de vos canaux a son propre identifiant que vous devez transmettre à ce stade. Vous pouvez obtenir vos identifiants de canaux en envoyant une demande à notre API Get Channel. Voyez ici à quoi doit ressembler exactement cette demande : Channels |
| xxx | channel.type | Nouveau paramètre. | Ce paramètre a une valeur fixe : "eTrusted". |
| xxx | type | Nouveau paramètre. |
Le paramètre type définit l'événement auquel l’avis est lié. Comme tous les avis dans MyTS étaient liées au passage en caisse du client, la valeur de ce paramètre est également fixée : "checkout". Si vous avez utilisé l'API ReviewRequest pour des avis non liés à une commande en particulier et que vous souhaitez utiliser un autre point de contact, veuillez nous contacter à l'adresse productintegration@trustedshops.com. |
| order. orderDate |
transaction. date |
Les paramètres correspondent les uns aux autres. |
Le paramètre transaction.date transmet l'heure de la commande à évaluer. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre order.orderDate. |
| order. orderReference |
transaction. reference |
Les paramètres correspondent les uns aux autres. |
Le paramètre transaction.reference transmet le numéro de la commande à évaluer. Dans le paramètre transaction.reference, transmettez la valeur que vous avez précédemment transmise dans le paramètre order.orderReference. |
| order. products |
products |
Les paramètres correspondent les uns aux autres. |
Ce paramètre permet de transférer les données nécessaires pour les avis produits. La fonctionnalité d'avis produit sera activée pour l'API Questionnaire Link au cours du troisième trimestre 2021. |
| consumer. firstname |
customer. firstname |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.firstname transmet le prénom de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.firstname. |
| consumer. lastname |
customer. lastname |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.lastname transmet le nom de famille de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.lastname. |
| consumer. contact.email |
customer. |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.email transmet l'adresse électronique de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.contact.email. |
| consumer. contact.language |
xxx |
Le paramètre n'existe plus. |
Le paramètre consumer.contact.language n'est plus utilisé dans l'API Questionnaire Link. Vous n'avez donc pas besoin de le configurer. |
| sender.type | xxx |
Le paramètre n'existe plus. |
Le paramètre sender.type n'est plus utilisé dans l'API Questionnaire Link. Vous n'avez donc pas besoin de le configurer. |
| types.key | xxx |
Le paramètre n'existe pas encore. |
Ce paramètre permet de transférer les données nécessaires pour les avis produits. La fonctionnalité d'avis produit sera activée pour l'API Questionnaire Link au cours du troisième trimestre 2021. |
| xxx | questionnaire Template.id |
Nouveau paramètre. |
Ce paramètre identifie le modèle de questionnaire à partir duquel est généré le questionnaire personnalisé pour votre clientèle. Découvrez les modèles de questionnaires au choix : Templates |
| xxx | system |
Nouveau paramètre. |
Le paramètre système identifie le système qui effectue la demande à l'API Questionnaire Link. À ce stade, utilisez une suite de caractères unique qui vous aidera à identifier votre composant. Ces informations peuvent être requises pour la communication avec le support technique. |
| xxx | systemVersion |
Nouveau paramètre. |
Utilisez différents numéros de version dans ce paramètre pour pouvoir identifier votre implémentation spécifique dans les cas de support. |
| xxx | metadata |
Nouveau paramètre. |
Vous pouvez utiliser ce paramètre non obligatoire pour ajouter des informations supplémentaires (p. ex. sur le client, l'événement, etc.) à des fins d'analyse. |
Si votre demande à l'API Questionnaire Link a réussi, vous recevrez une réponse selon le modèle suivant:
{
"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"
}
Dans le lien du paramètre, vous obtenez le lien vers le questionnaire généré. Vous pouvez maintenant intégrer ce lien dans le canal de communication de votre choix.
Conversion de l'ancienne API ReviewCollector / ReviewTrigger en une nouvelle API Event
Avec l'API ReviewCollector fournie pour My Trusted Shops ou l'API ReviewTrigger, vous avez pu déclencher l'envoi d'invitations d’avis à votre clientèle. Dans ce cas, vos clients ont reçu un e-mail envoyé par Trusted Shops avec un questionnaire d'évaluation. Si vous avez utilisé cette API jusqu'à présent, l'API Event développée pour eTrusted est l’API de remplacement appropriée pour ce cas d'utilisation. Grâce à l'API Event, vous pouvez lier l'heure d'envoi de vos invitations d'évaluation à n'importe quel point de contact de votre parcours client.
Pour vous montrer les différences entre l'ancienne API ReviewCollector ou ReviewTrigger et la nouvelle API Event aussi clairement que possible, nous présentons ci-dessous deux exemples de demandes d'API côte à côte. À gauche, vous voyez un exemple de demande à l'API ReviewCollector ou ReviewTrigger ; à droite, un exemple de demande à l'API Event.
| Système | 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, documentation |
| Body |
Nous allons maintenant vous expliquer en détail les différents paramètres afin de vous familiariser avec les différences et les réglages à effectuer. Vous pouvez également découvrir où les paramètres des deux requêtes API diffèrent l'un de l'autre.
| Paramètres API ReviewCollector / API ReviewTrigger | Paramètres API Event | Différences | Explication |
| tsid | channel.id |
Des informations nouvelles / supplémentaires doivent être fournies. |
L'ancien paramètre
tsid n'est plus nécessaire pour l'API Event. Au lieu de cela, chacun de vos canaux a son propre identifiant que vous devez transmettre à ce stade. Vous pouvez obtenir vos identifiants de canaux en envoyant une demande à notre API Get Channel. Voyez ici à quoi doit ressembler exactement cette demande : Channels |
| xxx | channel.type |
Nouveau paramètre. |
Ce paramètre a une valeur fixe : "eTrusted". |
| xxx | type |
Nouveau paramètre. |
Le paramètre type définit l'événement auquel l’avis est lié. Comme tous les avis dans MyTS étaient liées au passage en caisse du client, la valeur de ce paramètre est également fixée : "checkout". Si vous avez utilisé l'API ReviewCollector/ReviewTrigger pour des avis non liés à une commande en particulier et que vous souhaitez utiliser un autre point de contact, veuillez nous contacter à l'adresse productintegration@trustedshops.com. |
| reminderDate | xxx |
Le paramètre n'existe plus. |
Le paramètre reminderDate n'est plus utilisé dans l'API Event. Vous n'avez donc pas besoin de le configurer. La date concrète d’envoi des invitations est configurée dans le Centre de contrôle eTrusted à l’aide des paramètres de collecte optimisée des avis. Veuillez vous référer à cet article pour plus d'informations: Comment envoyer des invitations automatiques à mes clients ? |
| template.variant | xxx |
Le paramètre n'existe plus. |
Le paramètre template.variant n'est plus utilisé dans l'API Event. Vous n'avez donc pas besoin de le configurer. Le modèle de questionnaire souhaité est configuré dans le Centre de contrôle eTrusted à l’aide des paramètres de collecte optimisée des avis. Veuillez vous référer à cet article pour plus d'informations: Comment envoyer des invitations automatiques à mes clients ? |
| template. includeWidget |
xxx |
Le paramètre n'existe plus. |
Le paramètre template.includeWidget n'est plus utilisé dans l'API Event. Vous n'avez donc pas besoin de le configurer. |
|
order. |
transaction. |
Les paramètres correspondent les uns aux autres. |
Le paramètre transaction.date transmet l'heure de la commande à évaluer. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre order.orderDate. |
|
order. |
transaction. |
Les paramètres correspondent les uns aux autres. |
Le paramètre transaction.reference transmet le numéro de la commande à évaluer. Dans le paramètre transaction.reference, transmettez la valeur que vous avez précédemment transmise dans le paramètre order.orderReference. |
|
order. |
products |
Les paramètres correspondent les uns aux autres. |
Ce paramètre permet de transférer les données nécessaires pour les avis produits. |
|
order. |
xxx |
Le paramètre n'existe plus. |
Le paramètre order.currency n'est plus utilisé dans l'API Event. Vous n'avez donc pas besoin de le configurer. |
|
consumer. |
customer. |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.firstname transmet le prénom de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.firstname. |
|
consumer. |
customer. |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.lastname transmet le nom de famille de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.lastname. |
|
consumer. |
customer. |
Les paramètres correspondent les uns aux autres. |
Le paramètre customer.email transmet l'adresse électronique de votre client. Dans ce paramètre, transmettez la valeur que vous avez précédemment transmise dans le paramètre consumer.contact.email. |
|
xxx |
systemVersion |
Nouveau paramètre. |
Utilisez différents numéros de version dans ce paramètre pour pouvoir identifier votre implémentation spécifique dans les cas de support. |
|
xxx |
metadata |
Nouveau paramètre. |
Vous pouvez utiliser ce paramètre non obligatoire pour ajouter des informations supplémentaires (p. ex. sur le client, l'événement, etc.) à des fins d'analyse. |
Si votre demande à l'API Event a réussi, vous recevrez une réponse selon le modèle suivant :
{
"Message": "Your event (`evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx`) was accepted for processing.",
"EventRef": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
}
Votre client recevra alors une invitation d’avis.