API pro import inzerátů
Rozhraní pro realitní kanceláře a výrobce realitního softwaru, kteří chtějí inzeráty na Rocket Nemovitosti vkládat a aktualizovat automaticky. Import funguje jako jednoduché REST API — jeden HTTP požadavek na inzerát, formát JSON.
Získání API klíče
Klíč si vytvoříte sami po přihlášení v sekci Můj účet → API klíče. Zobrazí se jedinkrát při vytvoření, uložte si ho bezpečně. Importované inzeráty se zakládají pod vaším účtem (a vaší realitní kanceláří, pokud v ní jste), klíč můžete kdykoli deaktivovat. S dotazy se ozvěte na obchod@rocketreality.cz.
Endpoint
POST https://rocketnemovitosti.cz/api/import/inzeraty
Authorization: Bearer {váš API klíč}
Content-Type: application/jsonKaždý požadavek odešle jeden inzerát. Opakované odeslání se stejným externalId stávající inzerát aktualizuje — duplicity nevznikají.
Pole požadavku
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
| externalId | string | ano | Stálý identifikátor inzerátu ve vašem systému. Opakované odeslání se stejným externalId inzerát aktualizuje, nevytvoří duplicitu. |
| title | string | ano | Titulek inzerátu. |
| sourceUrl | string (URL) | ne | Odkaz na inzerát ve zdrojovém systému. |
| description | string | null | ne | Popis nemovitosti v prostém textu. |
| offerType | "sale" | "rent" | "auction" | "other" | ano | Typ nabídky — prodej, pronájem, dražba, jiné. |
| propertyType | string | null | ne | Druh nemovitosti, např. "apartment", "house", "land", "commercial". |
| disposition | string | null | u bytů | Dispozice bytu, např. "2+1", "3+kk", "pokoj". U kategorie byty je povinná — pokud ji neuvedete, zkusíme ji odvodit z názvu inzerátu. |
| price | number | null | ne | Cena v Kč. Null znamená cenu na vyžádání. |
| priceNote | string | ne | Poznámka k ceně, např. "k jednání" nebo "včetně provize". |
| currency | "CZK" | ano | Měna ceny. Aktuálně podporujeme pouze CZK. |
| size | number | ne | Užitná plocha v m². |
| location | objekt | ano | Adresa nemovitosti: street, city, postalCode, region. Do city lze uvést i městský obvod („Praha 4", „Brno-střed", „Moravská Ostrava a Přívoz") — obec dohledáme sami a obvod u inzerátu zachováme. Volitelně lat a lng — bez nich umístíme inzerát na střed obce, takže se na mapě překryje s ostatními. Volitelně také addressVisibility ("presna", "ulice", "obec") pro míru zpřesnění adresy na mapě. |
| photos | pole objektů | ano | Fotografie jako { url, alt }. Adresy musí být veřejně dostupné — portál si fotografie stáhne při zpracování. |
| attributes | objekt | ne | Podrobné parametry nemovitosti — viz samostatná tabulka níže. Posílejte jen ta, která znáte. |
| agent | objekt | null | ne | Kontakt na makléře: name, email, phone. Zobrazí se u inzerátu. |
Parametry nemovitosti (attributes)
Všechny parametry jsou nepovinné — pošlete jen ty, které znáte. Nevyplněný parametr hodnotu na inzerátu nepřepíše, takže opakovaný import nezruší údaje doplněné ručně.
| Pole | Hodnoty | Popis |
|---|---|---|
| ownership | osobni | druzstevni | statni_obecni | Typ vlastnictví. |
| buildingType | cihlova | panelova | drevostavba | skeletova | montovana | smisena | kamenna | jina | Konstrukce budovy. |
| buildingCondition | novostavba | velmi_dobry | dobry | spatny | ve_vystavbe | projekt | pred_rekonstrukci | v_rekonstrukci | po_rekonstrukci | k_demolici | Stav budovy. |
| furnishing | zarizeno | castecne_zarizeno | nezarizeno | Míra vybavení. |
| energyLabel | A … G | Energetická náročnost budovy. |
| priceUnit | celkem | za_m2 | za_mesic | za_m2_mesic | za_m2_rok | dohodou | Jednotka ceny. Bez uvedení se u pronájmů použije za_mesic, jinak celkem. |
| floorNumber | number | Podlaží, ve kterém se nemovitost nachází. |
| floorsTotal | number | Počet podlaží budovy. |
| builtUpArea | number | Zastavěná plocha v m². |
| gardenArea | number | Plocha zahrady v m². |
| monthlyFees | number | Měsíční poplatky v Kč. |
| deposit | number | Kauce v Kč (u pronájmů). |
| availableFrom | string (datum) | K nastěhování od. Přijímáme datum i datum s časem, uloží se datum. |
| orientation | pole hodnot | Světové strany: sever, jih, vychod, zapad, severovychod, severozapad, jihovychod, jihozapad. |
| hasBalcony / balconyArea | boolean / number | Balkon a jeho plocha v m². |
| hasTerrace / terraceArea | boolean / number | Terasa a její plocha v m². |
| hasLoggia / loggiaArea | boolean / number | Lodžie a její plocha v m². |
| hasCellar / cellarArea | boolean / number | Sklep a jeho plocha v m². |
| hasElevator | boolean | Výtah v budově. |
| hasGarage / garageCount | boolean / number | Garáž a počet stání. |
| hasParking / parkingCount | boolean / number | Parkování a počet míst. |
| barrierFree | boolean | Bezbariérový přístup. |
| videoUrl | string (URL) | Odkaz na video prohlídku. |
| virtualTourUrl | string (URL) | Odkaz na virtuální prohlídku. |
Příklad požadavku
curl -X POST https://rocketnemovitosti.cz/api/import/inzeraty \
-H "Authorization: Bearer VAS_API_KLIC" \
-H "Content-Type: application/json" \
-d '{
"externalId": "rk-1024",
"sourceUrl": "https://www.vase-rk.cz/nemovitosti/rodinny-dum-opava",
"title": "Rodinný dům 5+kk se zahradou, Opava",
"description": "Prostorný dům s garáží a udržovanou zahradou…",
"offerType": "sale",
"propertyType": "house",
"disposition": "5+kk",
"price": 8900000,
"priceNote": "k jednání",
"currency": "CZK",
"size": 145,
"location": {
"street": "Javorová 18",
"city": "Opava",
"postalCode": "74601",
"region": "moravskoslezsky",
"lat": 49.9387,
"lng": 17.9026
},
"photos": [
{ "url": "https://www.vase-rk.cz/foto/dum-1.jpg", "alt": "Pohled na dům" }
],
"attributes": {
"ownership": "osobni",
"buildingType": "cihlova",
"buildingCondition": "po_rekonstrukci",
"energyLabel": "C",
"floorsTotal": 2,
"gardenArea": 620,
"hasGarage": true,
"garageCount": 1,
"orientation": ["jih", "zapad"]
},
"agent": {
"name": "Jan Novák",
"email": "jan.novak@vase-rk.cz",
"phone": "+420 777 123 456"
}
}'Odpovědi
| Stav | Význam |
|---|---|
| 200 | Inzerát byl přijat ke zpracování (vytvoření nebo aktualizace). |
| 401 | Chybějící nebo neplatný API klíč. |
| 422 | Tělo požadavku neprošlo validací — odpověď obsahuje popis chyb. |
| 429 | Příliš mnoho požadavků — zkuste to znovu později. |
| 5xx | Chyba na naší straně — požadavek bezpečně zopakujte. |
Moderace a zveřejnění
Importované inzeráty procházejí stejnou moderací jako inzeráty vložené ručně. Po schválení se zveřejní; aktualizace již schválených inzerátů se propisují automaticky. Za obsah inzerátů odpovídá inzerující kancelář — viz podmínky užití.