Come faccio a configurare il collegamento alla mia API dopo l'aggiornamento a eTrusted?

In questa guida, ti spiegheremo come trasferire il collegamento della tua API dalla precedente piattaforma di valutazione My Trusted Shops alla nuova piattaforma eTrusted. Pertanto, questo articolo interessa esclusivamente quei negozi che, per il loro lavoro, hanno impostato un collegamento API con My Trusted Shops. Se anche il tuo negozio rientra in questo gruppo, riceverai un'e-mail con tutti i passaggi da seguire. Se, invece, non fai parte di questo gruppo ma sei comunque interessato alle API eTrusted, puoi contattare il nostro Centro sviluppatori e richiedere informazioni sulle varie possibilità: Vai al Centro sviluppatori
L'adeguamento del collegamento API richiede delle competenze tecniche. Pertanto, nel caso in cui non disponessi delle competenze necessarie, inoltra la presente guida al tuo reparto informatico oppure all'agenzia esterna di cui ti avvali.

Quando devo eseguire il trasferimento dell'API?

Prima di poter effettuare la tua configurazione, infatti, dobbiamo soddisfare alcuni requisiti necessari per un trasferimento API senza problemi. Per prima cosa, attiveremo il tuo account cliente (inclusi tutti i negozi) per l'ambiente della nuova piattaforma di valutazione eTrusted. Al contempo, configureremo un reindirizzamento dalle precedenti API di My Trusted Shops a quelle nuove di eTrusted. In questo modo potrai continuare a raccogliere, gestire e visualizzare facilmente le recensioni per il tuo negozio anche nella fase di transizione da una piattaforma API a un'altra.

Non appena riceverai la nostra comunicazione in cui ti informiamo che il tuo negozio è stato trasferito a eTrusted, potrai effettuare l'adeguamento della tua API. Per configurare le tue API eTrusted, segui questi tre semplici passaggi:

  1. Nel tuo account eTrusted vai alla sezione API Client Management per ottenere le tue API Client Credentials (Client ID e Client Secret) per le API eTrusted. Attenzione: Questo è possibile solo se hai i diritti di amministratore.
  2. Aiutandoti con la Documentazione relativa alle API di Trusted Shops, scopri quale API hai utilizzato finora.
  3. Segui la guida riportata qui sotto per configurare il nuovo collegamento alla tua API.
Ricorda che l'adeguamento dell'API deve essere implementato entro la fine dell'anno. Il 31 dicembre 2021 le API My Trusted Shops e, di conseguenza, il reindirizzamento dell'API configurato in precedenza saranno disattivati definitivamente. Se entro la suddetta data non avrai eseguito l'adeguamento delle API alla nuova piattaforma, non potrai più raccogliere recensioni.

Configurazione e autentificazione

Non appena ricevi le credenziali di accesso per le API eTrusted, puoi effettuare l'autenticazione sul nostro server di autorizzazione. Le nostre API sono protette mediante OAuth2. L'autentificazione avviene mediante una prima chiamata API al server di autorizzazione. Per vedere come deve avvenire la prima chiamata API, visita il nostro Centro sviluppatori: Setup and Authentication

Se la chiamata API avviene in modo corretto, riceverai una risposta contenente un token di accesso. Questo token di accesso deve essere presente nell'intestazione della richiesta di tutte le altre chiamate API successive.

I tuoi fornitori di servizi hanno bisogno di accedere alla piattaforma tramite le API eTrusted? Allora tieni presente che anche loro devono reimpostare la connessione API. Pertanto, informali per tempo e concedi loro l'accesso ai tuoi nuovi dati di login per le API eTrusted.
Informazioni dettagliate sull'autenticazione e sull'utilizzo del token di accesso all'interno dell'intestazione della richiesta sono riportate nella documentazione delle API eTrusted: Authentication

Passaggio dall'API ReviewRequest alla nuova API Questionnaire Link

Grazie all'API ReviewRequest, messa a disposizione da My Trusted Shops, era possibile integrare i link al questionario di valutazione di Trusted Shops nelle richieste di recensione personalizzate. Se finora hai utilizzato questa API, l'API Questionnaire Link, sviluppata appositamente per eTrusted, ne rappresenta il perfetto sostituto.

Attraverso l'API Questionnaire Link, puoi richiamare i link ai questionari preconfigurati in eTrusted per i tuoi clienti. Successivamente, puoi integrare questi link in un'e-mail, un SMS oppure un altro canale di comunicazione a tua scelta per raccogliere il feedback della tua clientela.

Tutte le informazioni sulla nostra API Questionnaire Link sono disponibili nella nostra documentazione API: Questionnaires

Per visualizzare le differenze tra la precedente API ReviewRequest e la nuova API Questionnaire Link, qui di seguito ti presentiamo due richieste API esemplificative a confronto. A sinistra, è riportato l'esempio di una richiesta all'API ReviewRequest; a destra, invece, è possibile vedere una richiesta all'API Questionnaire Link.

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, documentazione
Body ReviewRequestAPI.png QuestionnaireLinkAPI.png

Per comprendere al meglio le impostazioni necessarie, adesso spiegheremo meglio i vari parametri di configurazione. Inoltre, potrai vedere in che cosa si distinguono i parametri di entrambe le richieste API.

Parameter ReviewRequest API Parameter Questionnaire Link API Differenze Spiegazione
tsid channel.id

Devono essere messe a disposizione informazioni nuove/aggiuntive.

Il parametro precedente tsid non è più necessario per l'API Questionnaire Link. In sostituzione, ogni canale ha il proprio ID che deve essere indicato in questo parametro. Gli ID dei tuoi canali sono disponibili attraverso una richiesta alla nostra API Get Channel. Per scoprire come deve essere questa richiesta, consultare la seguente voce: Channels

xxx channel.type

Nuovo parametro.

Questo parametro ha un valore nuovo: "eTrusted".

xxx type

Nuovo parametro.

Il nuovo parametro type definisce l'evento a cui è collegata la recensione. Poiché in MyTS tutte le recensioni erano collegate al passaggio in cassa del cliente, anche il valore di questo parametro sarà "checkout". Se hai utilizzato l'API ReviewRequest per le recensioni non collegate agli ordini e pertanto desideri utilizzare un altro punto di contatto con il cliente, scrivici all'indirizzo e-mail productintegration@trustedshops.com.

order.
orderDate
transaction.
date

I parametri corrispondono.

Il parametro transaction.date trasmette il momento dell'ordine per il quale deve essere scritta una recensione. In questo parametro, indica il valore precedentemente indicato nel parametro order.orderDate.

order.
orderReference
transaction.
reference

I parametri corrispondono.

Il parametro transaction.reference trasmette il numero dell'ordine per il quale deve essere scritta una recensione. Nel parametro transaction.reference, indica il valore precedentemente indicato nel parametro order.orderReference.

order.
products
products

I parametri corrispondono.

In questo parametro vengono trasmessi i dati necessari per le recensioni dei prodotti. La funzionalità relativa alle recensioni dei prodotti per l'API Questionnaire Link verrà attivata nel terzo trimestre 2021.

consumer.
firstname
customer.
firstname

I parametri corrispondono.

Il parametro customer.firstname trasmette il nome del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.firstname.

consumer.
lastname
customer.
lastname

I parametri corrispondono.

Il parametro customer.lastname trasmette il cognome del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.lastname.

consumer.
contact.email
customer.
email

I parametri corrispondono.

Il parametro customer.email trasmette l'indirizzo e-mail del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.contact.email.

consumer.
contact.language
xxx

Questo parametro è stato eliminato.

Il parametro consumer.contact.language non viene più utilizzato nell'API Questionnaire Link. Per questo motivo, non devi configurarlo.

sender.type xxx

Questo parametro è stato eliminato.

Il parametro sender.type non viene più utilizzato nell'API Questionnaire Link. Per questo motivo, non devi configurarlo.

types.key xxx

Il parametro ancora non esiste.

In questo parametro vengono trasmessi i dati necessari per le recensioni dei prodotti. La funzionalità relativa alle recensioni dei prodotti per l'API Questionnaire Link verrà attivata nel terzo trimestre 2021.

xxx questionnaire
Template.id

Nuovo parametro.

In questo parametro, viene identificato il modello di questionario dal quale viene generato il questionario personalizzato del tuo cliente. Per visualizzare i modelli di questionario disponibili, dai uno sguardo qui: Templates

xxx system

Nuovo parametro.

Il parametro system identifica il sistema che esegue la richiesta verso l'API Questionnaire Link. Per questo parametro, utilizza una sequenza di caratteri univoca che ti aiuterà a identificare i tuoi componenti. Queste informazioni potrebbero essere necessarie per la comunicazione con l'assistenza.

xxx systemVersion

Nuovo parametro.

In questo parametro puoi utilizzare diversi numeri di versione per identificare la tua specifica implementazione in caso di assistenza.

xxx metadata

Nuovo parametro.

Questo parametro facoltativo può essere utilizzato per aggiungere delle informazioni con finalità di analisi (ad es. relative al cliente, all'evento ecc.).

Se la richiesta all'API Questionnaire Link viene eseguita in modo corretto, riceverai una risposta simile in base al seguente modello:

{
 "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"
}

Nel parametro link riceverai il link al questionario generato. Il link può essere integrato nel canale di comunicazione a tua scelta.

I link generati mediante l'API Questionnaire Link sono individuali e riservati a un cliente specifico. Di conseguenza, per ogni invito di recensione è necessario creare e integrare nella comunicazione un proprio link per il questionario.

Passaggio dalle precedenti API ReviewCollector/ReviewTrigger alla nuova API Event

Con l'API ReviewCollector e/o ReviewTrigger messa a disposizione da My Trusted Shops, era possibile attivare l'invio di inviti di recensione ai tuoi clienti. In questo caso, i tuoi clienti ricevevano un'e-mail di Trusted Shops con un questionario di valutazione. Se finora hai utilizzato questa API, l'API Event, sviluppata appositamente per eTrusted, ne rappresenta il perfetto sostituto. Con l'API Event puoi collegare l'invio dell'invito di recensione a un qualsiasi punto di contatto del Customer Journey.

Tutte le informazioni dettagliate sulla nostra API Event sono disponibili nella nostra documentazione API: Events

Per mostrarti le differenze tra la precedente API ReviewCollector e/o ReviewTrigger e la nuova API Event, qui di seguito ti presentiamo due richieste API esemplificative a confronto. A sinistra, è riportato l'esempio di una richiesta all'API ReviewCollector e/o ReviewTrigger; a destra, invece, è possibile vedere una richiesta all'API Event.

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, documentazione
Body ReviewTriggerAPI.png EventAPI.png

Per comprendere al meglio le differenze e le impostazioni necessarie, adesso spiegheremo meglio i vari parametri di configurazione. Inoltre, potrai vedere in che cosa si distinguono i parametri di entrambe le richieste API.

Parameter ReviewCollector / ReviewTrigger API Parameter Event API Differenze Spiegazione
tsid channel.id

Devono essere messe a disposizione informazioni nuove/aggiuntive.

Il parametro precedente tsid non è più necessario per l'API Event. In sostituzione, ogni canale ha il proprio ID che deve essere indicato in questo parametro. Gli ID dei tuoi canali sono disponibili attraverso una richiesta alla nostra API Get Channel. Per scoprire come deve essere questa richiesta, consultare la seguente voce: Channels

xxx channel.type

Nuovo parametro.

Questo parametro ha un valore nuovo: "eTrusted".

xxx type

Nuovo parametro.

Il nuovo parametro type definisce l'evento a cui è collegata la recensione. Poiché in MyTS tutte le recensioni erano collegate al passaggio in cassa del cliente, anche il valore di questo parametro sarà "checkout". Se hai utilizzato l'API ReviewCollector/ReviewTrigger per le recensioni non collegate agli ordini e pertanto desideri utilizzare un altro punto di contatto con il cliente, scrivici all'indirizzo e-mail productintegration@trustedshops.com.

reminderDate xxx

Questo parametro è stato eliminato.

Il parametro reminderDate non viene più utilizzato nell'API Event. Per questo motivo, non devi configurarlo. L'effettiva data di invio degli inviti viene configurata nel Centro di Controllo eTrusted grazie alle regole di invito. A tal proposito, consigliamo il seguente articolo: Come posso inviare inviti automatizzati ai miei clienti?

template.variant xxx

Questo parametro è stato eliminato.

Il parametro template.variant non viene più utilizzato nell'API Event. Per questo motivo, non devi configurarlo. L'effettivo modello di questionario viene configurato nel Centro di Controllo eTrusted grazie alle regole di invito. A tal proposito, consigliamo il seguente articolo: Come posso inviare inviti automatizzati ai miei clienti?

template.
includeWidget
xxx

Questo parametro è stato eliminato.

Il parametro template.includeWidget non viene più utilizzato nell'API Event. Per questo motivo, non devi configurarlo.

order.
orderDate

transaction.
date

I parametri corrispondono.

Il parametro transaction.date trasmette il momento dell'ordine per il quale deve essere scritta una recensione. In questo parametro, indica il valore precedentemente indicato nel parametro order.orderDate.

order.
orderReference

transaction.
reference

I parametri corrispondono.

Il parametro transaction.reference trasmette il numero dell'ordine per il quale deve essere scritta una recensione. Nel parametro transaction.reference, indica il valore precedentemente indicato nel parametro order.orderReference.

order.
products

products

I parametri corrispondono.

In questo parametro, vengono trasmessi i dati necessari per le recensioni dei prodotti.

order.
currency

xxx

Questo parametro è stato eliminato.

Il parametro order.currency non viene più utilizzato nell'API Event. Per questo motivo, non devi configurarlo.

consumer.
firstname

customer.
firstname

I parametri corrispondono.

Il parametro customer.firstname trasmette il nome del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.firstname.

consumer.
lastname

customer.
lastname

I parametri corrispondono.

Il parametro customer.lastname trasmette il cognome del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.lastname.

consumer.
contact.email

customer.
email

I parametri corrispondono.

Il parametro customer.email trasmette l'indirizzo e-mail del cliente. In questo parametro, indica il valore precedentemente indicato nel parametro consumer.contact.email.

xxx

systemVersion

Nuovo parametro.

In questo parametro, puoi utilizzare diversi numeri di versione per identificare la tua specifica implementazione in caso di assistenza.

xxx

metadata

Nuovo parametro.

Questo parametro facoltativo può essere utilizzato per aggiungere delle informazioni con finalità di analisi (ad es. relative al cliente, all'evento ecc.).

Se la richiesta all'API Event viene eseguita in modo corretto, riceverai una risposta simile in base al seguente modello:

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

Successivamente, il tuo cliente riceverà un invito di recensione.

Con ogni richiesta all'API Event generi un solo evento con il quale viene attivato l'invio di un invito di recensione. Se desideri generare più eventi in una sola volta, devi creare un loop. Il seguente articolo introduttivo al Centro sviluppatori potrebbe esserti di aiuto: The experience feedback setup

Questo articolo ti è stato utile?

Utenti che ritengono sia utile: 1 su 1