Primeros pasos con la API de análisis

Empezar a usar la API de análisis es muy sencillo. Solo tienes que conseguir una clave para la API y un secreto compartido, y comenzar las pruebas.

1. Colabora con nosotros

Para poder realizar la integración con la API de análisis, primero debes convertirte en colaborador con plantilla sin identificación de marca. Si aún no lo has hecho, puedes solicitarlo en el sitio web de Expedia Partner Solutions.

Hacerse colaborador con plantilla sin identificación de marca

2. Selecciona tus opciones

Cuando te hayas convertido en colaborador, podrás elegir entre nuestras opciones de dominio de datos:

Puntos de fidelidad: tus clientes podrán ganar puntos al contratar viajes contigo.
Itinerarios: proporciona asistencia a tus clientes para modificar o cancelar los planes de viaje que han hecho a través de tu sitio web.

A continuación, obtendrás las credenciales de la API y podrás configurar la autenticación. El método de autenticación diferirá en función del mecanismo de entrega que integres.

3. Prepárate para la autenticación con el método push

Se enviarán notificaciones mediante el método push al punto de conexión que proporciones. Para garantizar la seguridad y fiabilidad de la transmisión de datos, cada evento incluirá una firma de encabezado generada con tu clave API y tu secreto compartido. La firma del encabezado te permitirá autentificar y verificar a Expedia como remitente.

4. Configura la autenticación del método pull

Para acceder a los puntos de conexión de los itinerarios y de los puntos de fidelidad, necesitarás una clave API y un secreto compartido.

4.1 Solicita un token de acceso

Se te proporcionará un token válido que incorpora tus credenciales (contacta con tu gestor técnico de cuentas para obtener más información). Este token utiliza el mecanismo de autenticación básica HTTP. Tendrás que proporcionar una cabecera de autorización que contenga una cadena codificada en base64 de tu clave API y secreto compartido.

Ejemplo:

Authorization: Basic {api-key}:{shared-secret}

La llamada se realizará al punto de conexión del token que se documenta en las especificaciones de OpenAPI.

securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://analytics.ean.com/template/v1/oauth/token

Si la llamada de autenticación es válida, devolverá un token de portador que deberás utilizar en el siguiente paso.

4.2 Realiza una solicitud a la API utilizando el token

Empleamos el mecanismo de autenticación mediante token portador para los puntos de conexión de transactions o last_update. Tendrás que proporcionar un encabezado de autorización que contenga el token que recibiste en el paso anterior.

Ejemplo:

Authorization: Bearer {token}

4.3 Pon a prueba tus solicitudes

Cuando hayas recibido tus credenciales y configurado la autenticación, podrás comenzar a realizar solicitudes para valorar nuestro punto de conexión de prueba a través de la URL https://test.analytics.ean.com/. Cualquier dato devuelto a través de este punto de conexión es información de muestra que tiene la finalidad única de que comprendas la estructura de los datos.

Importante

Para garantizar que ofrecemos un servicio estable y sostenible para todos los colaboradores, aplicamos límites de tarifa a todas las llamadas a la API. Nuestro sistema controla el tráfico anómalo de la API y tomará medidas para protegerse automáticamente. Antes de aplicar cambios al comportamiento de llamar a la API o de realizar pruebas de rendimiento con acceso a la API, asegúrate de que revisas tus planes con tu consultor de la API de análisis.

Cuando hagas la prueba, tendrás que especificar la versión de tu API. Utiliza el valor servers.url de la especificación de OpenAPI para construir la URL. Estos dos valores son estándar:

Validación de la integración: test.analytics.ean.com
Punto de conexión de la producción: analytics.ean.com

Nota: Cuando cambies de punto de conexión, asegúrate de mantener el protocolo y la designación de la ruta (https://[test.]analytics.ean.com).

Ejemplo:

https://test.analytics.ean.com/template/v1/loyalty/earn/last_update
https://test.analytics.ean.com/template/v1/itineraries

El valor servers.url se encuentra en la parte superior de nuestros archivos de la especificación de OpenAPI descargables y siempre se corresponderá con el número de versión para el servicio de API en cuestión.

Ejemplo:

openapi: 3.0.1
info:
  title: Analytics API
  description: Analytics API V1
  version: v1

tags:
  - name: Analytics
    description: Template Analytics API

servers:
  - url: https://analytics.ean.com/template/v1
  - url: https://test.analytics.ean.com/template/v1