Saltar al contenido principal

Actualiza Bienes Raíces

La API para bienes raíces de app.neoagent.co proporciona la funcionalidad para actualizar los bienes raíces enviando una solicitud POST al endpoint /chat/Chatbot/RealEstateUpdate.

aviso

Atención: esta API es compatible solo con chatbots tradicionales y aún no es compatible con chatbots basados en plantillas.

Endpoint​

URL de la Solicitud: https://app.neoagent.co/chat/Chatbot/RealEstateUpdate
Método: POST

Headers requeridos​

La solicitud API debe incluir los siguientes encabezados:

  • Authorization: <Your-Secret-Key> - cadena, obligatorio - La clave secreta para autenticar la solicitud API
  • Content-Type: application/json - cadena, obligatorio - El tipo de contenido del payload de la solicitud (debe ser application/json)

Cuerpo de la Solicitud​

El cuerpo de la solicitud debe contener los siguientes parámetros:

{
// cadena, obligatorio - ID del chatbot (disponible en la configuración del chatbot -> general -> ID del chatbot)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// cadena, obligatorio - Valor de la clave primaria utilizada para la actualización
"Key": "PROP123456",
// cadena, obligatorio - Debe ser uno entre: [NewOaks, MLSNumber, URL]
"KeyType": "NewOaks",
// cadena, obligatorio - Debe ser uno entre: [for_sale, for_rent]
"SaleType": "for_sale",
// cadena, obligatorio - Debe ser uno entre: [Active, PreOnMarket, Sold]
"Status": "Active",
// cadena, obligatorio - Símbolo de la moneda (por ejemplo, $)
"CurrencySymbol": "$",
// cadena, obligatorio - Tipo de propiedad (por ejemplo, Residencial unifamiliar)
"PropertyType": "Residencial unifamiliar",
// número, obligatorio - Número de habitaciones
"Bedrooms": 3,
// número, obligatorio - Número de baños
"Bathrooms": 2.5,
// cadena, obligatorio - URL del anuncio
"Url": "https://example.com/property/123",
// cadena, obligatorio - Número MLS
"MLSNumber": "MLS123456",
// número, obligatorio - Año de construcción de la propiedad
"YearBuilt": 1998,
// número, obligatorio - Número de días en el mercado
"DaysOnMarket": 2,
// número, obligatorio - Superficie del lote
"LotArea": ​​800,
// número, obligatorio - Superficie del edificio
"BuildingArea": ​​2500,
// cadena, obligatorio - Debe ser uno entre: [Pies cuadrados, Metros cuadrados]
"AreaUnit": "Pies cuadrados",
// array - Array de URLs de imágenes
"Images": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg"
],
// cadena - Debe ser uno de los siguientes: [OpenHouse, 3D]
"Tours": "OpenHouse",
// número, obligatorio - Número de lugares de estacionamiento
"ParkingSpots": 8,
// cadena - Descripción de la propiedad
"Description": "Hermosa casa familiar con comodidades modernas",
// array - Información adicional sobre la propiedad en el formato [{'Key': 'xx', 'value': 'xx'}]
"ExtensionColumn": [
{
// cadena, obligatorio - El valor de la clave primaria utilizada para la actualización
"Key": "Pool",
"value": "Sí"
},
{
// cadena, obligatorio - El valor de la clave primaria utilizada para la actualización
"Key": "Garage",
"value": "2 autos"
}
],
// cadena - Descripción de la ubicación de la propiedad
"Location": "Zona residencial",
// cadena - Dirección
"Address": "123 Main St",
// cadena - Nombre de la ciudad
"City": "Los Ángeles",
// cadena - Nombre del estado
"State": "CA",
// cadena - Código postal
"ZIP": "90001",
// número - Latitud de la propiedad
"Latitude": 30.96,
// número - Longitud de la propiedad
"Longitude": -78.93,
// número - Precio de venta
"SalePrice": 100000,
// número - Precio por unidad de superficie
"UnitAreaPrice": 100,
// número - Cuota mensual de la asociación de propietarios
"HOAMonth": 500,
// número - Precio estimado
"ZestimatePrice": 100000,
// número - Precio mensual del alquiler
"RentPrice": 2500,
// cadena - Debe ser uno entre: [Todo el lugar, Habitación]
"SpaceType": "Todo el lugar",
// número - Monto del depósito requerido
"DepositFee": 5000
}

Parámetros​

  • SerialNumber - cadena, requerido - El ID del chatbot (encontrado en la configuración del chatbot -> general -> ID del chatbot)
  • Key - cadena, requerido - El valor de la clave primaria utilizada para la actualización
  • KeyType - cadena, requerido - Debe ser uno de: [NewOaks, MLSNumber, URL]
  • SaleType - cadena, requerido - Debe ser uno de: [for_sale, for_rent]
  • Status - cadena, requerido - Debe ser uno de: [Active, PreOnMarket, Sold]
  • CurrencySymbol - cadena, requerido - Símbolo de la moneda (por ejemplo, $)
  • PropertyType - cadena, requerido - Tipo de propiedad (por ejemplo, Residencial unifamiliar)
  • Bedrooms - número, requerido - Número de habitaciones
  • Bathrooms - número, requerido - Número de baños
  • Url - cadena, requerido - URL del anuncio de la propiedad
  • MLSNumber - cadena, requerido - Número MLS
  • YearBuilt - número, requerido - Año de construcción de la propiedad
  • DaysOnMarket - número, requerido - Número de días en el mercado
  • LotArea - número, requerido - Tamaño del área del lote
  • BuildingArea - número, requerido - Tamaño del área del edificio
  • AreaUnit - cadena, requerido - Debe ser uno de: [Pies cuadrados, Metros cuadrados]
  • Images - array - Array de URLs de imágenes
  • Tours - cadena - Debe ser uno de: [OpenHouse, 3D]
  • ParkingSpots - número, requerido - Número de lugares de estacionamiento
  • Description - cadena - Descripción de la propiedad
  • ExtensionColumn - array - Información adicional sobre la propiedad en formato [{'Key': 'xx', 'value': 'xx'}]
  • Location - cadena - Descripción de la ubicación de la propiedad
  • Address - cadena - Dirección de la calle
  • City - cadena - Nombre de la ciudad
  • State - cadena - Nombre del estado
  • ZIP - cadena - Código postal
  • Latitude - número - Latitud de la propiedad
  • Longitude - número - Longitud de la propiedad
  • SalePrice - número - Precio de venta
  • UnitAreaPrice - número - Precio por unidad de superficie
  • HOAMonth - número - Cuota mensual de la HOA
  • ZestimatePrice - número - Precio estimado
  • RentPrice - número - Precio de alquiler mensual
  • SpaceType - cadena - Debe ser uno de: [Todo el lugar, Habitación]
  • DepositFee - número - Monto del depósito requerido

Ejemplos de Solicitud​

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateUpdate', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "Key": "PROP123456",
  "KeyType": "NewOaks",
  "SaleType": "for_sale",
  "Status": "Active",
  "PropertyType": "Residencial unifamiliar",
  "Bedrooms": 3,
  "Bathrooms": 2.5,
  "MLSNumber": "MLS123456",
  "SalePrice": 100000
})
});

const data = await res.json();
console.log(data);

Respuesta​

La respuesta API será un objeto JSON con la siguiente estructura:

{
  // entero - Número de registros actualizados (1 indica éxito)
  "Data": 1,
  // cadena - versión de la API
  "Version": "1.0.0",
  // booleano - Estado de éxito de la operación
  "Success": true,
  // entero - código de estado HTTP
  "Code": 200,
  // cadena - Mensaje de error si hay alguno
  "Message": ""
}

Manejo de Errores​

Si la solicitud falla, debes:

  1. Verificar el código de estado HTTP por errores a nivel de red
  2. Examinar los campos Code y Message en la respuesta por errores a nivel de negocio
  3. El campo Message contendrá información detallada sobre el error