Cómo buscar destinos turísticos

Antes de buscar propiedades turísticas disponibles, necesita un código de región que identifique el destino. El punto final de autocompletar le permite buscar destinos por palabra clave y devuelve ciudades, estados, países y complejos turísticos individuales coincidentes junto con sus códigos de región.

Punto final

GET {{apihost}}/resorts/api/v2/search?key={searchterm}

Encabezados requeridos

Parámetros de consulta

Solicitud de ejemplo

GET {{api_host}}/resorts/api/v2/search?key=hawaii

Ejemplo de respuesta

{
  "status": 200,
  "data": [
    {
      "name": "Hawaii",
      "full_name": "Hawaii, United States",
      "city": "",
      "state": "Hawaii",
      "country": "United States",
      "region": "aGF3YWlp",
      "type": "state",
      "popularity": 95,
      "location": {
        "lat": 19.8968,
        "lon": -155.5828
      }
    },
    {
      "name": "Maui",
      "full_name": "Maui, Hawaii, United States",
      "city": "Maui",
      "state": "Hawaii",
      "country": "United States",
      "region": "bWF1aQ==",
      "type": "city",
      "popularity": 88,
      "location": {
        "lat": 20.7984,
        "lon": -156.3319
      }
    }
  ]
}

Campos de respuesta

Comprender el código de región

El campo region contiene un identificador codificado en Base64 que la API de Resorts utiliza internamente para determinar el alcance de las búsquedas de propiedades. No es necesario decodificar este valor; páselo directamente como el parámetro de ruta {xeniregioncode} al llamar al punto final de búsqueda de propiedades.

Comprender los tipos de resultados

El campo type le indica el alcance geográfico de cada resultado:

• resort — Una propiedad turística específica. La búsqueda con este código de región devuelve esa única propiedad.
• city — Un destino a nivel de ciudad. Devuelve todos los resorts de esa ciudad.
• state — Un estado o provincia. Devuelve todos los complejos turísticos del estado.
• country — Un destino a nivel de país. Devuelve todos los resorts del país.

Respuestas de error

400 — Falta clave de búsqueda

Se devuelve cuando el parámetro de consulta key falta o está vacío.

{
  "message": "Missing required parameter: key",
  "status": 400
}

404 — No se encontraron resultados

Se devuelve cuando ningún destino coincide con el término de búsqueda.

{
  "message": "No results found",
  "status": 404
}

Mejores prácticas

• Implementar escritura anticipada: llame a este punto final mientras el usuario escribe para proporcionar sugerencias de destino en tiempo real. Se recomienda un rebote de 300 ms.
• Mostrar full_name: muestra a los usuarios el nombre completo (por ejemplo, "Maui, Hawaii, Estados Unidos") para mayor claridad, especialmente cuando varios resultados comparten el mismo nombre corto.
• Almacene region y location: necesitará tanto el código de región (para el parámetro de ruta de búsqueda) como las coordenadas de latitud/longitud (para el cuerpo de la solicitud de búsqueda) en el siguiente paso.
• Utilice popularity para ordenar: ordene las sugerencias de autocompletar según el campo popularity para mostrar primero los destinos más relevantes.

Artículo siguiente: Cómo buscar complejos turísticos disponibles