¿Cuándo debería realizar la adaptación de la API?
Antes de que puedas pasar a la acción y para que la adaptación de la API tenga éxito, se deben cumplir algunos requisitos previos por nuestra parte. En primer lugar, activaremos tu cuenta de cliente (incluyendo todas tus tiendas) en el entorno productivo de la nueva plataforma de valoraciones eTrusted. Al mismo tiempo, estableceremos un reenvío de las APIs utilizadas hasta ahora por My Trusted Shops a las nuevas APIs de eTrusted. Esto garantiza que puedas seguir recopilando, gestionando y mostrando sin problemas las opiniones en tu tienda mientras se realiza la adaptación de tus APIs.
En cuanto recibas el mensaje de que tu tienda ha recibido la actualización a eTrusted, ha llegado el momento de adaptar la API. Ahora sigue los siguientes tres pasos para configurar tus APIs de eTrusted:
- En tu cuenta eTrusted accede a la sección de API Client Management para obtener tus API Client Credentials (Client ID y Client Secret) para las API de eTrusted. Ten en cuenta: Esto sólo es posible si tienes derechos de administrador.
- La documentación de nuestras APIs de My Trusted Shops te ayudará a descubrir qué APIs has utilizado hasta ahora.
- Sigue las siguientes instrucciones para configurar tu nueva conexión API.
Configuración y autenticación
En cuanto te hayamos enviado tus datos de acceso a las APIs de eTrusted, podrás autentificarte en nuestro Authorization Server (servidor de autorización). Nuestras APIs están protegidas mediante OAuth2. La autenticación se realiza a través de una llamada inicial de la API al servidor de autorización. En el Centro de desarrolladores puedes ver cómo debe ser la llamada inicial a la API: Setup and Authentication
Si la llamada a la API ha sido exitosa, recibirás una respuesta que contiene un token de acceso. Este token de acceso debe definirse en el encabezado de la solicitud de la llamada para todas las llamadas posteriores a la API.
Adaptación de la anterior API ReviewRequest a la nueva API Questionnaire Link
Con la API ReviewRequest, disponible para My Trusted Shops, podías integrar enlaces al cuestionario de valoración de Trusted Shops en peticiones de valoración personalizadas individualmente. Si hasta ahora has utilizado esta API, deberás sustituirla por la API Questionnaire Link, desarrollada para eTrusted.
A través de la API Questionnaire Link puedes recuperar enlaces a cuestionarios preconfigurados para tus clientes en eTrusted. A continuación, puedes integrar estos enlaces en un correo electrónico, un SMS u otro canal de comunicación de tu elección para recopilar opiniones de clientes.
Para reconocer de un vistazo las diferencias entre la antigua API ReviewRequest y la nueva API Questionnaire Link, te presentamos a continuación dos ejemplos de solicitudes API, una al lado de la otra. En el lado izquierdo verás un ejemplo de solicitud a la API ReviewRequest, en el lado derecho un ejemplo de solicitud a la API Questionnaire Link.
| Sistema | 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, documentación |
| Body |
Para entender mejor los ajustes necesarios, pasamos a detallar los parámetros individuales. También descubrirás en qué se diferencian los parámetros de las dos solicitudes de la API.
| Parámetro API ReviewRequest | Parámetro API Questionnaire Link | Diferencias | Explicación |
| tsid | channel.id |
Es necesario proporcionar nueva / más información. |
El antiguo parámetro tsid ya no es necesario para la API Questionnaire Link. En su lugar, debes transferir el ID propio de cada uno de tus canales. Para obtener los ID de tus canales, realiza una solicitud a nuestra API Get Channel. Aquí conocerás cómo debe ser exactamente esta solicitud: Channels |
| xxx | channel.type |
Nuevo parámetro. |
Este parámetro tiene un valor fijo: "eTrusted". |
| xxx | type |
Nuevo parámetro. |
El parámetro type define el evento al que se vincula la valoración. Dado que todas las valoraciones en MyTS estaban vinculadas al pago de la compra por parte del cliente, el valor de este parámetro también es fijo: "checkout". Si has utilizado la API ReviewRequest para valoraciones no relacionadas con pedidos y, por lo tanto, deseas utilizar un punto de contacto diferente, ponte en contacto con nosotros vía productintegration@trustedshops.com. |
| order. orderDate |
transaction. date |
Los parámetros se corresponden entre sí. |
El parámetro transaction.date transfiere la hora del pedido a valorar. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro order.orderDate. |
| order. orderReference |
transaction. reference |
Los parámetros se corresponden entre sí. |
El parámetro transaction.reference transfiere el número del pedido a valorar. En el parámetro transaction.reference, se transfiere el valor que previamente se transfería en el parámetro order.orderReference. |
| order. products |
products |
Los parámetros se corresponden entre sí. |
En este parámetro se transfieren los datos necesarios para las valoraciones de producto. La funcionalidad para las valoraciones de producto se habilitará durante el tercer trimestre de 2021 para la API Questionnaire Link. |
| consumer. firstname |
customer. firstname |
Los parámetros se corresponden entre sí. |
El parámetro customer.firstname transfiere el nombre de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.firstname. |
| consumer. lastname |
customer. lastname |
Los parámetros se corresponden entre sí. |
El parámetro customer.lastname transfiere el apellido de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.lastname. |
| consumer. contact.email |
customer. |
Los parámetros se corresponden entre sí. |
El parámetro customer.email transfiere la dirección de correo electrónico de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.contact.email. |
| consumer. contact.language |
xxx |
El parámetro ya no existe. |
El parámetro consumer.contact.language ya no se utiliza en la API Questionnaire Link. Por lo tanto, no es necesario configurarlo. |
| sender.type | xxx |
El parámetro ya no existe. |
El parámetro sender.type ya no se utiliza en la API Questionnaire Link. Por lo tanto, no es necesario configurarlo. |
| types.key | xxx |
El parámetro aún no existe. |
En este parámetro se transfieren los datos necesarios para las valoraciones de producto. La funcionalidad para las valoraciones de producto se habilitará durante el tercer trimestre de 2021 para la API Questionnaire Link. |
| xxx | questionnaire Template.id |
Nuevo parámetro. |
Este parámetro identifica la plantilla de cuestionario a partir de la cual se genera el cuestionario individual para tu clientela. Aquí encontrarás las plantillas de cuestionarios que puedes elegir: Templates |
| xxx | system |
Nuevo parámetro. |
El parámetro system identifica el sistema que realiza la solicitud a la API Questionnaire Link. Utiliza en este punto una secuencia de caracteres que te ayude a identificar su componente. Esta información puede ser necesaria en la comunicación con el servicio de soporte. |
| xxx | systemVersion |
Nuevo parámetro. |
Utiliza en este parámetro diferentes números de versión para poder identificar en los casos de soporte tu implementación específica. |
| xxx | metadata |
Nuevo parámetro. |
Puedes utilizar este parámetro, no obligatorio, para añadir información adicional (por ejemplo, sobre el cliente, el evento, etc.) con fines de análisis. |
Si tu solicitud a la API Questionnaire Link fue exitosa, recibirás una respuesta de acuerdo a la siguiente plantilla:
{
"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"
}
El parámetro link contiene el enlace al cuestionario generado. Ahora puedes integrar este enlace en el canal de comunicación de tu elección.
Conversión de la anterior API ReviewCollector / API ReviewTrigger a la nueva API Event
La API disponible para My Trusted Shops ReviewCollector o ReviewTrigger se encargaba de desencadenar el envío de invitaciones de valoración a tus clientes. En este caso, tus clientes recibían un correo electrónico enviado por Trusted Shops con un cuestionario de valoración. Si hasta ahora has utilizado esta API, deberás sustituirla por la API Event, desarrollada para eTrusted. Con la API Event, puedes vincular la hora de envío de tus invitaciones de valoración con cualquier punto de contacto a lo largo del recorrido del cliente.
Para mostrarte las diferencias, de la forma más clara posible, entre la antigua API ReviewCollector o ReviewTrigger y la nueva API Event, te presentamos a continuación dos ejemplos de solicitudes API, una al lado de la otra. En el lado izquierdo verás un ejemplo de solicitud a la API ReviewCollector o ReviewTrigger, en el lado derecho un ejemplo de solicitud a la API Event.
| Sistema | 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, documentación |
| Body |
A continuación explicaremos los parámetros individuales para que conozcas las diferencias y los ajustes necesarios. También descubrirás en qué se diferencian los parámetros de las dos solicitudes de la API.
| Parámetro API ReviewCollector / ReviewTrigger | Parámetro API Event | Diferencias | Explicación |
| tsid | channel.id |
Es necesario proporcionar nueva / más información. |
El antiguo parámetro tsid ya no es necesario para la API Event. En su lugar, debes transferir el ID propio de cada uno de tus canales. Para obtener los ID de tus canales, realiza una solicitud a nuestra API Get Channel. Aquí conocerás cómo debe ser exactamente esta solicitud: Channels |
| xxx | channel.type |
Nuevo parámetro. |
Este parámetro tiene un valor fijo: "eTrusted". |
| xxx | type |
Nuevo parámetro. |
El parámetro type define el evento al que se vincula la valoración. Dado que todas las valoraciones en MyTS estaban vinculadas al pago de la compra por parte del cliente, el valor de este parámetro también es fijo: "checkout". Si has utilizado la API ReviewCollector/ReviewTrigger para valoraciones no relacionadas con pedidos y, por lo tanto, deseas utilizar un punto de contacto diferente, ponte en contacto con nosotros vía productintegration@trustedshops.com. |
| reminderDate | xxx |
El parámetro ya no existe. |
El parámetro reminderDate ya no se utiliza en la API Event. Por lo tanto, no es necesario configurarlo. La fecha de envío concreta de las invitaciones se establece en el Centro de Control de eTrusted con ayuda de los ajustes para la recopilación optimizada de valoraciones. Consulta este artículo para obtener más información: ¿Cómo envío invitaciones automáticas a mis clientes? |
| template.variant | xxx |
El parámetro ya no existe. |
El parámetro template.variant ya no se utiliza en la API Event. Por lo tanto, no es necesario configurarlo. La plantilla de cuestionario deseada se configura en el Centro de Control de eTrusted con ayuda de los ajustes para la recopilación optimizada de valoraciones. Consulta este artículo para obtener más información: ¿Cómo envío invitaciones automáticas a mis clientes? |
| template. includeWidget |
xxx |
El parámetro ya no existe. |
El parámetro template.includeWidget ya no se utiliza en la API Event. Por lo tanto, no es necesario configurarlo. |
|
order. |
transaction. |
Los parámetros se corresponden entre sí. |
El parámetro transaction.date transfiere la hora del pedido a valorar. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro order.orderDate. |
|
order. |
transaction. |
Los parámetros se corresponden entre sí. |
El parámetro transaction.reference transfiere el número del pedido a valorar. En el parámetro transaction.reference, se transfiere el valor que previamente se transfería en el parámetro order.orderReference. |
|
order. |
products |
Los parámetros se corresponden entre sí. |
En este parámetro se transfieren los datos necesarios para las valoraciones de producto. |
|
order. |
xxx |
El parámetro ya no existe. |
El parámetro order.currency ya no se utiliza en la API Event. Por lo tanto, no es necesario configurarlo. |
|
consumer. |
customer. |
Los parámetros se corresponden entre sí. |
El parámetro customer.firstname transfiere el nombre de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.firstname. |
|
consumer. |
customer. |
Los parámetros se corresponden entre sí. |
El parámetro customer.lastname transfiere el apellido de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.lastname. |
|
consumer. |
customer. |
Los parámetros se corresponden entre sí. |
El parámetro customer.email transfiere la dirección de correo electrónico de tu cliente. En este parámetro, se transfiere el valor que previamente se transfería en el parámetro consumer.contact.email. |
|
xxx |
systemVersion |
Nuevo parámetro. |
Utiliza en este parámetro diferentes números de versión para poder identificar en los casos de soporte tu implementación específica. |
|
xxx |
metadata |
Nuevo parámetro. |
Puedes utilizar este parámetro, no obligatorio, para añadir información adicional (por ejemplo, sobre el cliente, el evento, etc.) con fines de análisis. |
Si tu solicitud a la API Event fue exitosa, recibirás una respuesta de acuerdo a la siguiente plantilla:
{
"Message": "Your event (`evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx`) was accepted for processing.",
"EventRef": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
}
Tu cliente recibirá entonces una invitación de valoración.