Saltar al contenido principal

Crea Real Estate

La API para el real estate de app.neoagent.co proporciona la funcionalidad para crear un nuevo chatbot de bienes raíces enviando una solicitud POST al endpoint /chat/Chatbot/RealEstateCreate.

Endpoint​

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

Encabezados 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 - 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 de la propiedad
"Url": "https://example.com/property/123",
// cadena, obligatoria - 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, obligatoria - Debe ser uno entre: [Square Feet, Square Meters]
"AreaUnit": "Square Feet",
// array - Array de URLs de imágenes
"Images": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg"
],
// cadena - Debe ser uno entre: [OpenHouse, 3D]
"Tour": "OpenHouse",
// número, obligatorio - Número de espacios 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": [
{
"Key": "Piscina",
"value": "Sí"
},
{
"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 mantenimiento
"HOAMonth": 500,
// número - Precio estimado
"ZestimatePrice": 100000,
// número - Precio de alquiler mensual
"RentPrice": 2500,
// cadena - Debe ser uno entre: [Espacio completo, Habitación]
"SpaceType": "Espacio completo",
// número - Monto del depósito requerido
"DepositFee": 5000
}

Parámetros​

  • SerialNumber - cadena, obligatorio - ID del chatbot (disponible en la configuración del chatbot -> general -> ID del chatbot)
  • SaleType - cadena, obligatorio - Debe ser uno entre: [for_sale, for_rent]
  • Status - cadena, obligatorio - Debe ser uno entre: [Active, PreOnMarket, Sold]
  • CurrencySymbol - cadena, obligatorio - Símbolo de la moneda (por ejemplo, $)
  • PropertyType - cadena, obligatorio - Tipo de propiedad (por ejemplo, Residencial unifamiliar)
  • Bedrooms - número, obligatorio - Número de habitaciones
  • Bathrooms - número, obligatorio - Número de baños
  • Url - cadena, obligatorio - URL del anuncio de la propiedad
  • MLSNumber - cadena, obligatorio - Número MLS
  • YearBuilt - número, obligatorio - Año de construcción de la propiedad
  • DaysOnMarket - número, obligatorio - Número de días en el mercado
  • LotArea - número, obligatorio - Superficie del lote
  • BuildingArea - número, obligatorio - Superficie del edificio
  • AreaUnit - cadena, obligatorio - Debe ser uno entre: [Square Feet, Square Meters]
  • Images - array - Array de URLs de imágenes
  • Tour - cadena - Debe ser uno entre: [OpenHouse, 3D]
  • ParkingSpots - número, obligatorio - Número de espacios de estacionamiento
  • Description - cadena - Descripción de la propiedad
  • ExtensionColumn - array - Información adicional sobre la propiedad en el formato [{'Key': 'xx', 'value': 'xx'}]
  • Location - cadena - Descripción de la ubicación de la propiedad
  • Address - cadena - Dirección
  • 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 mantenimiento
  • ZestimatePrice - número - Precio estimado
  • RentPrice - número - Precio de alquiler mensual
  • SpaceType - cadena - Debe ser uno entre: [Espacio completo, Habitación]
  • DepositFee - número - Monto del depósito requerido

Ejemplos de Solicitud​

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateCreate', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "SaleType": "for_sale",
  "Status": "Active",
  "CurrencySymbol": "$",
  "PropertyType": "Residencial unifamiliar",
  "Bedrooms": 3,
  "Bathrooms": 2.5,
  "Url": "https://example.com/property/123",
  "MLSNumber": "MLS123456",
  "YearBuilt": 1998,
  "DaysOnMarket": 2,
  "LotArea": 800,
  "BuildingArea": 2500,
  "AreaUnit": "Square Feet",
  "ParkingSpots": 8
})
});

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

Respuesta​

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

{
"Data": "PROP123456",
// cadena - Versión de 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 está presente
"Message": ""
}

Manejo de Errores​

Si la solicitud falla, debes:

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