Passa al contenuto principale

Crea Real Estate

L'API per il real estate di app.neoagent.co fornisce la funzionalità per creare un nuovo chatbot real estate inviando una richiesta POST all'endpoint /chat/Chatbot/RealEstateCreate.

Endpoint​

URL della Richiesta: https://app.neoagent.co/chat/Chatbot/RealEstateCreate
Metodo: POST

Headers richiesti​

La richiesta API deve includere i seguenti header:

  • Authorization: <Your-Secret-Key> - string, obbligatorio - La chiave segreta per autenticare la richiesta API
  • Content-Type: application/json - string, obbligatorio - Il tipo di contenuto del payload della richiesta (deve essere application/json)

Corpo della Richiesta​

Il corpo della richiesta deve contenere i seguenti parametri:

{
// stringa, obbligatorio - ID del chatbot (disponibile nelle impostazioni del chatbot -> generale -> ID chatbot)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// stringa, obbligatorio - Deve essere uno tra: [for_sale, for_rent]
"SaleType": "for_sale",
// stringa, obbligatorio - Deve essere uno tra: [Active, PreOnMarket, Sold]
"Status": "Active",
// stringa, obbligatorio - Simbolo della valuta (ad esempio, $)
"CurrencySymbol": "$",
// stringa, obbligatorio - Tipo di immobile (ad esempio, Residenziale unifamiliare)
"PropertyType": "Residenziale unifamiliare",
// numero, obbligatorio - Numero di camere da letto
"Bedrooms": 3,
// numero, obbligatorio - Numero di bagni
"Bathrooms": 2.5,
// stringa, obbligatorio - Annuncio dell'immobile URL
"Url": "https://example.com/property/123",
// stringa, obbligatoria - Numero MLS
"MLSNumber": "MLS123456",
// numero, obbligatorio - Anno di costruzione dell'immobile
"YearBuilt": 1998,
// numero, obbligatorio - Numero di giorni di permanenza sul mercato
"DaysOnMarket": 2,
// numero, obbligatorio - Superficie del lotto
"LotArea": ​​800,
// numero, obbligatorio - Superficie dell'edificio
"BuildingArea": ​​2500,
// stringa, obbligatoria - Deve essere uno tra: [Square Feet, Square Meters]
"AreaUnit": "Square Feet",
// array - Array di URL delle immagini
"Images": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg"
],
// stringa - Deve essere uno tra: [OpenHouse, 3D]
"Tour": "OpenHouse",
// numero, obbligatorio - Numero di posti auto
"ParkingSpots": 8,
// stringa - Descrizione dell'immobile
"Description": "Splendida casa di famiglia con comfort moderni",
// array - Informazioni aggiuntive sull'immobile nel formato [{'Key': 'xx', 'value': 'xx'}]
"ExtensionColumn": [
{
"Key": "Piscina",
"value": "Sì"
},
{
"Key": "Garage",
"value": "2 auto"
}
],
// stringa - Descrizione dell'ubicazione dell'immobile
"Location": "Zona residenziale",
// stringa - Indirizzo
"Address": "123 Main St",
// stringa - Nome della città
"City": "Los Angeles",
// stringa - Nome dello stato
"State": "CA",
// stringa - Codice postale
"ZIP": "90001",
// numero - Latitudine dell'immobile
"Latitude": 30,96,
// numero - Longitudine dell'immobile
"Longitude": -78,93,
// numero - Prezzo di vendita
"SalePrice": 100000,
// numero - Prezzo per unità di superficie
"UnitAreaPrice": 100,
// numero - Canone condominiale mensile
"HOAMonth": 500,
// numero - Prezzo stimato
"ZestimatePrice": 100000,
// numero - Canone di affitto mensile
"RentPrice": 2500,
// stringa - Deve essere uno tra: [Intero spazio, Stanza]
"SpaceType": "Intero spazio",
// numero - Importo del deposito richiesto
"DepositFee": 5000
}

Parametri​

  • SerialNumber - stringa, obbligatorio - ID del chatbot (disponibile nelle impostazioni del chatbot -> generale -> ID chatbot)
  • SaleType - stringa, obbligatorio - Deve essere uno tra: [for_sale, for_rent]
  • Status - stringa, obbligatorio - Deve essere uno tra: [Active, PreOnMarket, Sold]
  • CurrencySymbol - stringa, obbligatorio - Simbolo della valuta (ad esempio, $)
  • PropertyType - stringa, obbligatorio - Tipo di immobile (ad esempio, Residenziale unifamiliare)
  • Bedrooms - numero, obbligatorio - Numero di camere da letto
  • Bathrooms - numero, obbligatorio - Numero di bagni
  • Url - stringa, obbligatorio - URL dell'annuncio immobiliare
  • MLSNumber - stringa, obbligatorio - Numero MLS
  • YearBuilt - numero, obbligatorio - Anno di costruzione dell'immobile
  • DaysOnMarket - numero, obbligatorio - Numero di giorni sul mercato
  • LotArea - numero, obbligatorio - Superficie del lotto
  • BuildingArea - numero, obbligatorio - Superficie dell'edificio
  • AreaUnit - stringa, obbligatorio - Deve essere uno tra: [Square Feet, Square Meters]
  • Images - array - Array di URL di immagini
  • Tours - stringa - Deve essere uno tra: [OpenHouse, 3D]
  • ParkingSpots - numero, obbligatorio - Numero di posti auto
  • Description - stringa - Descrizione della proprietà
  • ExtensionColumn - array - Informazioni aggiuntive sulla proprietà nel formato [{'Key': 'xx', 'value': 'xx'}]
  • Location - stringa - Descrizione della posizione della proprietà
  • Address - stringa - Indirizzo
  • City - stringa - Nome della città
  • State - stringa - Nome della provincia
  • ZIP - stringa - Codice postale
  • Latitude - numero - Latitudine della proprietà
  • Longitude - numero - Longitudine della proprietà
  • SalePrice - numero - Prezzo di vendita
  • UnitAreaPrice - numero - Prezzo per unità di superficie
  • HOAMonth - numero - Quota condominiale mensile
  • ZestimatePrice - numero - Prezzo Zestimate
  • RentPrice - numero - Prezzo di affitto mensile
  • SpaceType - stringa - Deve essere uno tra: [Intero spazio, Stanza]
  • DepositFee - numero - Importo del deposito richiesto

Esempi di Richiesta​

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": "Single Family Residential",
  "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);

Risposta​

La risposta API sarà un oggetto JSON con la seguente struttura:

{
"Data": "PROP123456",
// stringa - Versione API
"Versione": "1.0.0",
// booleano - Stato di riuscita dell'operazione
"Success": true,
// intero - Codice di stato HTTP
"Code": 200,
// stringa - Messaggio di errore, se presente
"Message": ""
}

Gestione degli Errori​

Se la richiesta fallisce, dovresti:

  1. Controllare il codice di stato HTTP per errori a livello di rete
  2. Esaminare i campi Code e Message nella risposta per errori a livello business
  3. Il campo Message conterrà informazioni dettagliate sull'errore