API de autocompletado para Rapid

Ofrece sugerencias a los viajeros mientras buscan

Typehead (GET /suggestions) es un nuevo punto de acceso de la API que te permite ofrecer a los viajeros una experiencia de búsqueda con sugerencias basada en regiones geográficas, ubicaciones relevantes y el inventario disponible. Este punto final devuelve una lista de sugerencias basadas en cadenas de búsqueda parciales y en los parámetros de solicitud que hayas introducido. Ponte en contacto con tu gestor de cuentas para añadir Typeahead a tu cuenta.

Funcionamiento

La API Typeahead es una herramienta de predicción de texto, que a veces se conoce como «autocompletado» o «sugerencia automática». Te muestra una lista de regiones, ubicaciones o artículos del inventario según la información parcial que hayas introducido en el cuadro de búsqueda. Cuando el usuario escriba en el cuadro de búsqueda, la API de Typeahead empezará a mostrar hasta 10 resultados basándose en la información de la ciudad, la región, el artículo en stock o el código postal. A continuación, puedes elegir una opción de esta lista para iniciar la búsqueda o seguir escribiendo para seguir afinando los resultados que te sugiere automáticamente.

Por ejemplo, si escribes «Memp» en el buscador, te aparecerán varias opciones geográficas, como barrios, estaciones de tren, aeropuertos, etc., relacionadas con Memphis (Tennessee, EE. UU.), seguidas de Memphis (Misuri, EE. UU.).

Guía de inicio

Tendrás que ponerte en contacto con tu gestor de cuentas o con un representante de Partner Connect para obtener más información sobre la API. Te pedirán que les des tu autorización y, si te la conceden, modificarán tu contrato para incluir Typeahead. Una vez que se haya activado Typeahead para tu organización, el representante de Partner Connect te ayudará con cualquier desarrollo que sea necesario.

Requisitos de lanzamiento:

Tienes que adoptar y utilizar el proceso de tokens de acceso opacos para la autenticación.
>> Más información sobre los tokens de acceso opacos
Los tokens de acceso solo los puede usar el mismo ID de circuito o la misma clave API que los solicitó.
Los tokens de acceso solo duran 4 horas.
Las solicitudes de nuevos tokens de acceso deben configurarse para que se actualicen de forma regular según ese calendario y no con demasiada frecuencia.
El idioma y el texto de la solicitud son parámetros obligatorios.

>> Ver todos los idiomas compatibles con Rapid

Alternativa de Google Places para Typeahead

Si Typeahead no puede ofrecer un resultado para una búsqueda concreta, recurrirá a Google Places para mostrarte uno. En este caso, el cuerpo de la respuesta será idéntico al de cualquier otra respuesta de Typeahead; sin embargo, si los resultados proceden de Google, se devolverá un encabezado de respuesta:Third-Party-Result-Source: Google. La función de alternativa de Google está disponible para todos los socios, pero hay que activarla en Partner Connect a través de la configuración de Switchbox. Es un requisito operativo que todos los socios incluyan la atribución adecuada, de acuerdo con las normas de Google Políticas de atribución.

Autorización y acceso

La API de Rapid Typeahead está disponible para que los socios que actualmente utilicen la versión 3 de Rapid puedan realizar solicitudes a través de los puntos de acceso de la API. Una vez aprobado, tu perfil actual tendrá los permisos necesarios para usar correctamente la API.

>> Descubre cómo funciona la autorización OAuth 2.0.

Solicitudes de sugerencias

La API de sugerencias necesita cierta información en los encabezados de la solicitud y en los parámetros de consulta. Para que la respuesta sea más sólida, también puedes incluir parámetros de consulta opcionales.

Encabezados de solicitud

Campo obligatorio

Accept: especifica el formato de respuesta que el cliente quiere recibir. Este valor debe ser application/json.
Accept-Encoding: especifica la codificación de la respuesta que el cliente quiere recibir. Este valor tiene que ser « gzip ».
User-Agent: una cadena de encabezado de la solicitud del cliente, tal y como la ha capturado tu integración. Si estás desarrollando una aplicación, el valor de « User-Agent » debería ser « {app name}/{app version} ». Por ejemplo,TravelNow/3.30.112.

Parámetros de consulta

Campo obligatorio

language: especifica el idioma deseado para la respuesta como un subconjunto del formato BCP47 que solo utiliza pares separados por un guion de los códigos de idioma y país de two-digit. Usa solo los códigos de idioma ISO 639-1 alfa-2 y los códigos de país ISO 3166-1 alfa-2 tal y como se describen en w3.org (por ejemplo, language=en-US).

>> Echa un vistazo a la lista de idiomas compatibles
>> Ir a w3.org

text: la cadena de entrada que quieres consultar, con un límite de 150 caracteres (por ejemplo, text=Springfie).

Opcional

type: describe el lugar que estás buscando. Este parámetro se puede especificar varias veces con valores diferentes (por ejemplo, type=AIRPORT&type=CITY). Si no se especifica, por defecto se incluirán todos los tipos. Echa un vistazo a la tabla de valores permitidos que aparece a continuación para ver las opciones disponibles.
line_of_business: Este parámetro proporciona reglas de búsqueda, y un valor válido garantiza que la respuesta sea más relevante. Aunque este parámetro es opcional, si no lo incluyes puede afectar a los resultados de la búsqueda, así que hemos establecido un valor por defecto para cada una de las API de Rapid. Echa un vistazo a la tabla de valores permitidos que aparece a continuación para ver las opciones disponibles.
package_type: filtra según los tipos de paquetes que elijas. Echa un vistazo a la tabla de valores permitidos que aparece a continuación para ver las opciones disponibles.
feature: cambia la forma de calcular los resultados de las sugerencias. Entre los valores se incluyen hierarchy, nearby_airport y postal_code.
region_id: filtra los resultados según la región que elijas.
origin: indica si el texto de la consulta es un origen en lugar de un destino. La búsqueda predeterminada solo te mostrará destinos.
limit: especifica el número máximo de sugerencias que devuelve la respuesta. Este valor tiene que estar entre 1 y 10 (por ejemplo, limit=5). Si no se indica este parámetro, el valor por defecto es 10.

Valores permitidos

type	line_of_business	package_type
`airport`	`properties`	`flight_property`
`city`	`flights`	`flight_property_car`
`multi_city_vicinity`	`packages`	`flight_car`
`neighborhood`	`cars`	`property_car`
`point_of_interest`	`activities`
`airport_metro_code`
`multi_region`
`train_station`
`metro_station`
`address`
`property`
`bus_station`

Nota: Cualquier valor que no aparezca en la tabla anterior provocará un error.

Solicitud de datos

Una vez que tengas el access_token, tendrás que configurar la solicitud GET.

Solicitud de muestra - API de alojamiento

GET - https://api.ean.com/v3/suggestions?language=en-US&line_of_business=properties&limit=3&text=chicago&type=city&type=neighborhood 

Header : 
Authorization: Bearer {{access_token}}

Respuesta de ejemplo - API de alojamiento

[
  {
    "related_id": "4477519",
    "type": "airport",
    "name": "Chicago, IL (ORD-O'Hare Intl.)",
    "name_full": "Chicago, IL, United States of America (ORD-O'Hare Intl.)",
    "name_display": "<B>Chicago</B>, IL, United States of America (ORD-O'Hare Intl.)",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "ORD",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.976977,
      "longitude": -87.90481
    }
  },
  {
    "related_id": "829",
    "type": "city",
    "name": "Chicago",
    "name_full": "Chicago, Illinois, United States of America",
    "name_display": "<B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.878113,
      "longitude": -87.629799
    }
  },
  {
    "related_id": "6350699",
    "type": "neighborhood",
    "name": "Downtown Chicago",
    "name_full": "Downtown Chicago, Chicago, Illinois, United States of America",
    "name_display": "Downtown <B>Chicago</B>, <B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.885969845574834,
      "longitude": -87.62933540465228
    }
  }
]

Códigos de error

La API de Typeahead comparte los mismos códigos de error que el resto de APIs de Rapid.

>> Más información sobre las respuestas de error más comunes

Interactuar con otras API de Rapid

Cuando el usuario final escribe texto en la barra de búsqueda, la API de Typeahead recupera la información de la región (ID, nombre, coordenadas, etc.) o del elemento, dependiendo del parámetro « type » especificado en la búsqueda. A continuación, la API muestra esa información como resultados en la lista de autocompletado.

Cuando el usuario selecciona una región de la lista de autocompletado, se llama a la API de regiones para obtener una lista de los productos disponibles en esa región. Usa los ID que te devuelva esa búsqueda para llamar a la API de Shopping, consultar la disponibilidad y mostrar la lista.

Si el usuario selecciona un artículo de la lista de autocompletado, la API de Shopping generará una página de detalles con información sobre la disponibilidad y los datos concretos del stock.

Detalles de la API

Explora las definiciones de los puntos de conexión relacionados 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 quieres probar todos los puntos finales de Rapid API como si quieres descargar sus especificaciones OpenAPI o nuestra colección de Postman, tenemos lo que necesitas.