Notificaciones

En esta página se describe el servicio de notificaciones, mediante el que recibes alertas de eventos relacionados con las reservas.

Información general

Las notificaciones de Rapid API son una solución que te permite integrarte más que nunca con la aplicación. Cuando se produzcan cambios que puedan causar algún impacto en tu negocio, Rapid volcará los detalles del cambio directamente en tus sistemas mediante mensajes POST estándar. Con nuestras notificaciones, podrás estar al día, simplificar las operaciones y aumentar tu volumen de negocio.

Actualmente admitimos notificaciones de todos los eventos de reservas que tengan lugar fuera de nuestra API. De esta manera, si un centro de llamadas realiza un cambio o un hotel cancela una reserva, recibirás una notificación inmediatamente. Esto es solo el principio, ya que pronto llegarán más tipos de notificaciones de eventos.

Mediante una integración fluida con tu empresa, estas notificaciones sirven para complementar los siguientes productos y servicios de Rapid.

• Rapid
• Herramienta de reservas para agentes Affiliate Voyager
• Servicios de atención al cliente y al colaborador

Ahora ofrecemos una API de prueba para todos los tipos de eventos compatibles con las notificaciones. Encontrarás todos los detalles en la siguiente sección principal. Si no quieres configurar tus propias solicitudes, puedes utilizar nuestra nueva herramienta de comprobación de notificaciones.

Tipos de mensajes admitidos

Las notificaciones de Rapid pueden informar a tus sistemas mediante un mensaje relacionado con los siguientes eventos:

Esquema y detalles de los mensajes

Todos los mensajes deben cumplir el esquema que se describe a continuación. Es posible que el esquema varíe a medida que se añadan nuevos tipos de mensajes para diferentes eventos.

Cada mensaje es una solicitud POST HTTPS con un cuerpo de mensaje JSON.

Importante: Para poder recibir notificaciones, los colaboradores deben estar habilitados para cada tipo de evento de forma individual. Si quieres habilitar un nuevo tipo de evento en la API de notificaciones, contacta con el servicio de asistencia de Rapid.

Ejemplo de "itinerary.agent.create"

{
     "event_id": "dbacce6c-afcb-4b23-ae66-48050757551c",
     "event_type": "itinerary.agent.create",
     "event_time": "2017-08-09T16:47:32.039Z",
     "itinerary_id": "8091234567890",
     "email": "customer@example.com",
     "message": "An agent created a new itinerary.",
     "affiliate_reference_id": "b086d299-2f1f-4134-a23c-f4a1c9286fac"
 }

Ejemplo de "itinerary.supplier.confirm"

{
    "event_id": "e02d6f41-4708-476f-915d-8a7032942e94",
    "event_type": "itinerary.supplier.confirm",
    "event_time": "2018-04-28T20:31:03.423Z",
    "itinerary_id": "8999989898988",
    "email": "alice@example.com",
    "message": "The supplier confirmed one or more rooms on this itinerary.",
    "affiliate_reference_id": "R194193582",
    "rooms": [
        {
            "confirmation_id": {
                "expedia": "926784314",
                "property": "BEF23123AA"
            }
        },
        {
            "confirmation_id": {
                "expedia": "926784315"
            }
        }
    ]
}

Ejemplo de "itinerary.message.received"

{
  "event_id": "1aed5641-7285-4c42-b079-f5f2f139d148",
  "event_type": "itinerary.message.received",
  "event_time": "2023-11-14T02:33:18.860105363Z",
  "itinerary_id": "9025254271673",
  "email": "john@email.com",
  "message": "We accept your request for river view room. Looking forward to your visit",
  "affiliate_reference_id": "b086d299-2f1f-4134-a23c-f4a1c9286fac"
}

Integración

Recepción de un mensaje

Para empezar a recibir notificaciones, tendrás que establecer un punto de conexión que pueda aceptar mensajes POST que se envíen a dicho punto de conexión. El punto de conexión debe cumplir los criterios siguientes:

• Ser de acceso público.
• Tener habilitado HTTPS y TLS 1.2 o una versión superior.
• Configurar un certificado TLS válido, en el que confíen la mayoría de las aplicaciones modernas (es posible que no se confíe en un certificado con autofirma).

Trabaja con tu asesor de integración de Rapid para configurarlo y proporciónale la información siguiente:

• Una lista de los tipos de eventos a la que quieras suscribirte (enumerada más arriba).
• La dirección URL de tu punto de conexión para gestionar los mensajes.

Estamos trabajando para facilitarte herramientas de autogestión que te permitan probar la integración. Hasta entonces, el asesor de integración te puede ayudar a realizar reservas de prueba para confirmar que recibes las notificaciones de los eventos ocurridos fuera de línea a los que te has suscrito.

Notas importantes sobre la configuración

• Rapid utiliza servidores en la nube. Asegúrate de que los puntos de conexión del receptor estén configurados para recibir notificaciones procedentes de distintas direcciones IP.
• Si quieres cambiar la URL de tu punto de conexión, debes mantener activo la URL hasta que validemos la nueva para recibir notificaciones. Ponte en contacto con tu representante de Rapid antes de realizar este tipo de cambios.
• Solo se puede utilizar una URL para recibir notificaciones. No se admite ninguna variación del event_type ni de ningún otro criterio.

Gestión de un mensaje

Cuando recibas un mensaje en el que se indique que ha tenido lugar un evento de reserva, utiliza el ID del itinerario y la dirección de correo electrónico del mensaje para recuperar los detalles de la última reserva.

Puede que los mensajes lleguen desordenados. Consulta la marca de hora para determinar el orden y recupera el itinerario de los eventos de reservas para obtener el estado actualizado.

Después de recibir el mensaje, la integración deberá responder con el código de estado HTTP adecuado. Los mensajes que no reciban un código de estado de nivel 200 no se considerarán enviados y se pondrán en cola para que el servicio de notificaciones vuelva a intentarlo.

Mensajes que no se pueden entregar

Si no podemos entregar un mensaje correctamente en tu punto de conexión, volveremos automáticamente a intentarlo siguiendo el esquema descrito a continuación:

• Primer reintento después de 5 minutos.
• Segundo reintento después de 1 hora.
• Los reintentos subsiguientes, cada 12 horas durante 7 días (14 en total).

Puede que recibas un mensaje duplicado si no recibimos la confirmación de recepción (código de estado correcto 200) y se ha puesto el mensaje en cola para volver a intentarlo. Para detectar un mensaje duplicado, busca el mismo event_id pero con una timestamp posterior a la original.

API de notificaciones que no se pueden entregar

Esta solicitud devuelve las notificaciones no entregadas de tu suscripción y tus puntos de conexión de prueba. Los mensajes se devuelven en función de la clave de la API proporcionada. Se considera que un mensaje no se puede entregar después de 7 días de intentos de entrega activos (consulta la sección anterior), periodo tras el cual se trasladan al almacenamiento para que esta API los recupere.

• Los mensajes que no se puedan entregar se devolverán solo una vez. Todos los mensajes que devuelva tu solicitud se eliminarán del almacén de datos. Planifica tu gestión de respuestas para esta API según corresponda.
• Con cada solicitud se devuelven hasta 25 mensajes no entregados.
• Las solicitudes enviadas a api.ean.com devolverán tanto notificaciones de prueba como de producción en una sola respuesta. Las solicitudes enviadas a nuestro punto de conexión de prueba, test.ean.com, no se admiten oficialmente. Recomendamos no usar el punto de conexión de prueba mientras los puntos de conexión de producción estén activos, ya que se podrían devolver notificaciones de producción que después se eliminarían.

Esquema y detalles de los mensajes

Los mensajes que no se pueden entregar y que devuelve esta API siguen el mismo esquema que las notificaciones de producción, tal y como se describe en las secciones anteriores.

Ejemplo - 2 mensajes no entregados

[
    {
        "event_id": "e02d6f41-4708-476f-915d-8a7032942e94",
        "event_type": "itinerary.agent.change",
        "event_time": "2018-04-28T20:31:03.423Z",
        "itinerary_id": "1204309424793",
        "email": "alice@example.com",
        "message": "An agent changed this itinerary.",
        "affiliate_reference_id": "R194193582"
    },
    {
        "event_id": "fe97op1b-595a-406e-8e0e-90108d5cb4a1",
        "event_type": "itinerary.agent.cancel",
        "event_time": "2018-05-24T04:08:50.839Z",
        "itinerary_id": "1204329124126",
        "email": "bob@sample.net",
        "message": "An agent canceled one or more rooms on this itinerary.",
        "affiliate_reference_id": ""
    }
]

API de comprobación de notificaciones

La API de comprobación de notificaciones de Rapid te permite solicitar que se envíen notificaciones de prueba al punto de conexión de prueba especificado para verificar tu integración con el servicio de notificaciones. También puedes utilizar nuestro Evaluador del servicio de notificaciones para enviar notificaciones de prueba directamente a tu punto de conexión sin tener que generar tus propias solicitudes.

Notas importantes

La función de solicitud de este servicio no es compatible con la API de notificaciones de producción. No puedes enviar solicitudes al punto de conexión activo para activar o actualizar notificaciones de producción. Las solicitudes se ofrecen a través de esta API de comprobación exclusivamente con fines de prueba.

Dado que esta API es exclusivamente para fines de prueba, el activador de solicitudes POST solo está disponible a través de test.ean.com.

Esquema y tipos de mensajes admitidos

Todas las notificaciones de prueba siguen el mismo esquema y los mismos tipos de mensajes que las notificaciones de producción, tal y como se describe en la documentación de la API de notificaciones anterior a esta sección.

Integración

Recepción de un mensaje

Para comenzar a recibir notificaciones, tendrás que establecer un punto de conexión HTTPS públicamente accesible que pueda aceptar mensajes POST que se envíen a dicho punto de conexión.

Trabaja con tu asesor de integración de Rapid para configurarlo y proporciónale la información siguiente:

• Una lista de los tipos de eventos a la que quieras suscribirte para las pruebas (enumerada en la sección anterior).
• La dirección URL de tu punto de conexión de prueba para gestionar las notificaciones de prueba.

Si no recibes una notificación de prueba después de 30 minutos desde la solicitud, contacta con tu asesor de integración de Rapid para que te ayude a resolver el problema.

Notas importantes

Notas importantes

• En las notificaciones que recibas, no habrá distinciones entre una notificación de prueba y una de producción. Te recomendamos encarecidamente que configures un punto de conexión específico para las notificaciones de prueba para poder separar correctamente los mensajes de prueba frente a los de producción.
• Si configuras diferentes puntos de conexión para las notificaciones de prueba y de producción, solo recibirás notificaciones de prueba en el punto de conexión de prueba, y del mismo modo, solo recibirás notificaciones de producción en el punto de conexión de producción.

Al configurar diferentes puntos de conexión para las notificaciones de prueba y de producción, solo recibirás notificaciones de prueba en el punto de conexión de prueba, y del mismo modo, solo recibirás notificaciones de producción en el punto de conexión de producción.

Verificación de notificaciones

Para verificar que las notificaciones se originen en Rapid, enviaremos un encabezado de solicitud para validar el evento.

Cuando Rapid envíe una notificación, recibirás un encabezado de autorización. Se trata del mismo encabezado de autorización que envías con cualquier solicitud a la API.

Rapid enviará el encabezado de autorización con el formato siguiente:

Authorization: EAN
APIKey=yourAPIKey,Signature=sha512Hash,timestamp=UNIXTimestampUsedForTheSignature

Validación

Para validar el evento, deberás comparar el hash SHA512 de la firma del encabezado con uno que generes usando tu clave de la API, el secreto compartido y la marca de hora del encabezado de solicitud.

Consulta la página de referencia de verificación por firma para ver cómo construir el hash.

Notas importantes

Detalles de la API

Explora las definiciones de los puntos de conexión relacionados con las notificaciones en esta página y usa API Explorer u otro software de pruebas para ver la diferencia entre los ejemplos y las definiciones de esquemas, y el resultado real.

Recursos adicionales

Tanto si lo que quieres es probar todos los puntos de conexión de Rapid API como si quieres descargar las especificaciones de OpenAPI o nuestra colección de Postman, tenemos lo que necesitas.

Ir a API Explorer