Общие требования к XML-файлам
Технические требования:
- URL фида должен быть постоянным и доступным по протоколу HTTP
- Фид должен быть в кодировке UTF-8 или Windows-1251
- Регистр тегов важен! Используйте точный регистр как в документации
- Документ должен содержать корневой элемент
Создание застройщика
Обязательные данные:
- Название для отображения - будет видно пользователям
- Фид ЖК - ссылка на XML - 1 или более файлов
- Фид квартир - ссылка на XML - 1 или более файлов
- Логотип - квадратный, формат - png, мин. 132×132, лучше 500×500
Рекомендации:
- Частота обновления фидов - начинаем загрузку раз в час на 57 минуте
- Когда данные появятся на сайте - обработка занимает время и зависит от объема данных и текущей нагрузки системы
- Доступность фидов - стабильные публичные URL, без авторизации
- Валидаторы - перед публикацией проверьте фиды: ЖК Квартиры
Фид ЖК
* - обязательный параметр
Массивы: Поля типа array указываются
повторяющимися тегами с одинаковым именем.
Структура XML фида:
- Корневой тег фида:
<rcfeed> - Версия фида:
<version>(например: 1) - Все ЖК находятся внутри общего тега
<objects> - Каждый объект ЖК обозначается тегом
<RCSchema>
Описание полей объекта ЖК
| Элемент | Описание | Допустимые значения / Ограничения | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ExternalId | Идентификатор ЖК |
integer
уникальный
📘 Справочник ЖК и корпусов |
||||||||||||||||
| Name | Наименование ЖК |
string
1-255 символов |
||||||||||||||||
| Description | Описание ЖК |
string
15-3000 символов Чтобы разбить описание на абзацы, начните текст с новой строки XML-кода. Теги форматирования текста не будут обработаны. Дубли пустых строк, html-теги, непечатные символы будут удалены. Замена символов
|
||||||||||||||||
| Buildings | Список корпусов | array | ||||||||||||||||
| BuildingsSchema | Объект корпуса | object | ||||||||||||||||
| ExternalId | Идентификатор корпуса |
integer
уникальный
📘 Справочник ЖК и корпусов |
||||||||||||||||
| Name | Название корпуса |
string
уникальный
|
||||||||||||||||
| Class | Класс ЖК |
string
|
||||||||||||||||
| MaterialType | Материал здания |
string
|
||||||||||||||||
| FloorsCount | Количество этажей | integer | ||||||||||||||||
| PassengerLiftsCount | Количество пассажирских лифтов | integer | ||||||||||||||||
| CargoLiftsCount | Количество грузовых лифтов | integer | ||||||||||||||||
| Address | Адрес объекта |
string
Регион, город, улица, дом |
||||||||||||||||
| Coordinates | Координаты объекта |
object
|
||||||||||||||||
| Lat | Широта | double | ||||||||||||||||
| Lng | Долгота | double | ||||||||||||||||
| Parking | Парковка | object | ||||||||||||||||
| Type | Тип парковки |
string
Обязательно, если указан блок Parking
|
||||||||||||||||
| Deadline | Срок сдачи | object | ||||||||||||||||
| Quarter | Квартал |
string
|
||||||||||||||||
| Year | Год | integer | ||||||||||||||||
| IsComplete | Дом сдан | boolean | ||||||||||||||||
| Photos | Фотографии объекта |
array
Без водяных знаков, чужих объектов, рекламных баннеров и дублей Не размещайте дубли изображений в одном объявлении
|
||||||||||||||||
| PhotoSchema | Объект фото | object | ||||||||||||||||
| FullUrl | URL изображения | string URL | ||||||||||||||||
| IsDefault | Является ли фото по-умолчанию |
boolean
Не более 1 фото с IsDefault = true
|
||||||||||||||||
| Undergrounds | Станции метро |
array
До 3 станций |
||||||||||||||||
| UndergroundInfoSchema | Объект метро |
object
Обязательно, если указан блок Undergrounds |
||||||||||||||||
| Id | Идентификатор станции |
integer
уникальный
Обязательно, если указан блок UndergroundInfoSchema 📘 Справочник станций метро |
||||||||||||||||
| Time | Время в пути до метро в минутах |
integer
Обязательно, если указан блок UndergroundInfoSchema |
||||||||||||||||
| TransportType | Способ передвижения |
string
Обязательно, если указан блок UndergroundInfoSchema
|
Пример XML
<rcfeed>
<version>1</version>
<objects>
<RCSchema>
<ExternalId>123</ExternalId>
<Name>ЖК Солнечный</Name>
<Description>Современный жилой комплекс</Description>
<Buildings>
<BuildingsSchema>
<ExternalId>building-1</ExternalId>
<Name>Корпус 1</Name>
<Class>comfort</Class>
<MaterialType>monolith</MaterialType>
<FloorsCount>25</FloorsCount>
<PassengerLiftsCount>2</PassengerLiftsCount>
<CargoLiftsCount>1</CargoLiftsCount>
<Address>г. Москва, ул. Центральная, д. 5</Address>
<Coordinates>
<Lat>55.7559</Lat>
<Lng>37.6174</Lng>
</Coordinates>
<Parking>
<Type>underground</Type>
</Parking>
<Deadline>
<Quarter>third</Quarter>
<Year>2025</Year>
<IsComplete>false</IsComplete>
</Deadline>
</BuildingsSchema>
</Buildings>
<Photos>
<PhotoSchema>
<FullUrl>https://example.com/image1.jpg</FullUrl>
<IsDefault>true</IsDefault>
</PhotoSchema>
<PhotoSchema>
<FullUrl>https://example.com/image2.jpg</FullUrl>
<IsDefault>false</IsDefault>
</PhotoSchema>
</Photos>
<Undergrounds>
<UndergroundInfoSchema>
<Id>1</Id>
<Time>5</Time>
<TransportType>transport</TransportType>
</UndergroundInfoSchema>
<UndergroundInfoSchema>
<Id>2</Id>
<Time>15</Time>
<TransportType>walk</TransportType>
</UndergroundInfoSchema>
</Undergrounds>
</RCSchema>
</objects>
</rcfeed>
Фид квартир
* - обязательный параметр
Массивы: Поля типа array указываются
повторяющимися тегами с одинаковым именем.
Структура XML фида:
- Все квартиры находятся внутри общего тега
<feed> - Каждый объект квартиры обозначается тегом
<object> - Обязательно указание версии фида:
<feed_version>(например: 2)
Описание полей объекта Квартира
| Элемент | Описание | Допустимые значения | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Category | Категория объявления |
string
newBuildingFlatSale- квартира в новостройке |
||||||||||||||||
| ExternalId | Внешний идентификатор объявления |
string
уникальный
|
||||||||||||||||
| RoomType | Тип комнат |
string
Изолированные комнаты- с отдельным выходом в общую зону и без прохода между собой.
|
||||||||||||||||
| Description | Текст объявления и описание объекта недвижимости |
string
15-3000 символов Чтобы разбить описание на абзацы, начните текст с новой строки XML-кода. Теги форматирования текста не будут обработаны. Дубли пустых строк, html-теги, непечатные символы будут удалены. Замена символов
|
||||||||||||||||
| Coordinates | Координаты местоположения объекта | object | ||||||||||||||||
| Lat | Широта | double | ||||||||||||||||
| Lng | Долгота | double | ||||||||||||||||
| CadastralNumber | Кадастровый номер | string | ||||||||||||||||
| FlatRoomsCount | Количество комнат |
integer
|
||||||||||||||||
| IsApartments | Является ли объект апартаментами |
boolean
Юридически квартира считается жилым помещением, а апартаменты - нежилым. В апартаментах невозможна постоянная регистрация, только временная |
||||||||||||||||
| IsPenthouse | Является ли объект пентхаусом |
boolean
Пентхаус - большая квартира, занимающая весь верхний этаж дома, или надстройка на крыше. |
||||||||||||||||
| TotalArea | Общая площадь, м² |
double
Жилые помещения + Кухня < Общая площадь |
||||||||||||||||
| FloorNumber | Этаж |
integer
|
||||||||||||||||
| JKSchema | Информация о ЖК | object | ||||||||||||||||
| Id | Идентификатор ЖК |
integer
уникальный
📘 Справочник ЖК и корпусов |
||||||||||||||||
| Name | Название ЖК | string | ||||||||||||||||
| House | Информация о корпусе |
object
Обязательно, если указан блок JKSchema |
||||||||||||||||
| Id | Идентификатор корпуса |
integer
уникальный
📘 Справочник ЖК и корпусов |
||||||||||||||||
| Name | Название корпуса | string | ||||||||||||||||
| Flat | Квартира | object | ||||||||||||||||
| FlatNumber | Номер квартиры | string | ||||||||||||||||
| SectionNumber | Номер секции | string | ||||||||||||||||
| FlatType | Тип квартиры | string | ||||||||||||||||
| RoomDefinitions |
Площадь комнат, м²
(альтернативный вариант) |
array
Количество тегов Room должно быть равно количеству комнат. Лишние теги Room игнорируются. Если комнат больше 6 (многоквартирная, свободная планировка), количество тегов Room не ограничивается. При публикации объявления из фида площади комнат отображаются в поле «Площадь комнат» в формате: 20-17-13.5
|
||||||||||||||||
| Room | Комната |
object
|
||||||||||||||||
| Area | Площадь комнаты, м² |
string
Допустимы только цифры. Точка (не более одной), и запятая (не более одной) Варианты заполнения: 13.5 - допустимо 13,5 - допустимо |
||||||||||||||||
| LivingArea | Жилая площадь, м² |
double
Сумма площадей комнат (без кухни, холлов, коридоров, санузлов, балконов и кладовок). Разница общей площади и суммы (жилая + кухня) должна быть не менее 5 м². При несоблюдении правила система отнимет недостающую часть от жилой площади. |
||||||||||||||||
| KitchenArea | Площадь кухни, м² |
double
Площадь кухни должна быть больше 4 м². Сумма жилой площади и площади кухни не должна быть больше или равна общей. |
||||||||||||||||
| LoggiasCount | Количество лоджий |
integer
Количество лоджий может быть от 1 до 4. Для однокомнатных квартир максимальное значение балконов + лоджий = 2 |
||||||||||||||||
| BalconiesCount | Количество балконов |
integer
Количество балконов может быть от 1 до 4. Для однокомнатных квартир максимальное значение балконов + лоджий = 2 |
||||||||||||||||
| LayoutPhoto | Планировка |
object
Если для планировки IsDefault = True или IsDefault не заполнен, она будет первым изображением в объявлении. Если IsDefault = False, планировка будет вторым изображением, а первым будет фото со значением IsDefault = True в теге Photos. Без водяных знаков, чужих объектов, рекламных баннеров
|
||||||||||||||||
| FullUrl | URL исходного изображения |
string
Обязательно, если указан блок LayoutPhoto |
||||||||||||||||
| IsDefault | Является ли фото по-умолчанию |
boolean
IsDefault = True может быть установлен только для одного LayoutPhoto. |
||||||||||||||||
| PhotoType | Тип фото |
string
|
||||||||||||||||
| Photos | Фотографии объекта |
array
Без фотографий квартира не будет отображаться в каталоге Без водяных знаков, чужих объектов, рекламных баннеров и дублей Не размещайте дубли изображений в одном объявлении
|
||||||||||||||||
| PhotoSchema | Объект фото | object | ||||||||||||||||
| FullUrl | URL изображения | string URL | ||||||||||||||||
| IsDefault | Является ли фото по-умолчанию |
boolean
Не более 1 фото с IsDefault = true
|
||||||||||||||||
| PhotoType | Тип фото |
string
|
||||||||||||||||
| Decoration | Отделка |
string
|
||||||||||||||||
| ProjectDeclarationUrl | Проектная декларация | string URL | ||||||||||||||||
| WindowsViewType | Вид из окон |
array
string
Формат массива: Для указания нескольких значений используйте повторяющиеся
теги:
<WindowsViewType>yard</WindowsViewType>
|
||||||||||||||||
| SeparateWcsCount | Количество раздельных санузлов |
integer
Количество санузлов может быть от 1 до 9 |
||||||||||||||||
| CombinedWcsCount | Количество совмещённых санузлов |
integer
Количество санузлов может быть от 1 до 9 |
||||||||||||||||
| HasRamp | Наличие пандуса | boolean | ||||||||||||||||
| Title | Заголовок объявления |
string
Максимальная длина: 255 символов |
||||||||||||||||
| Building | Информация о здании | object | ||||||||||||||||
| CeilingHeight | Высота потолков, м | double | ||||||||||||||||
| Apartment | Номер квартиры | string | ||||||||||||||||
| BargainTerms | Условия сделки | object | ||||||||||||||||
| Price | Цена |
object
Максимальное значение - 9_999_999_999 |
||||||||||||||||
| Currency | Валюта |
string
|
||||||||||||||||
| MortgageAllowed | Возможна ли продажа в ипотеку | boolean | ||||||||||||||||
| SaleType | Тип продажи |
string
|
Пример XML
<feed>
<feed_version>2</feed_version>
<object>
<Category>newBuildingFlatSale</Category>
<ExternalId>10001</ExternalId>
<RoomType>separate</RoomType>
<Description>Просторная квартира с отдельными комнатами</Description>
<Coordinates>
<Lat>55.7558</Lat>
<Lng>37.6173</Lng>
</Coordinates>
<CadastralNumber>77:01:0004010:123</CadastralNumber>
<FlatRoomsCount>2</FlatRoomsCount>
<IsApartments>false</IsApartments>
<IsPenthouse>false</IsPenthouse>
<TotalArea>60.0</TotalArea>
<LivingArea>36.0</LivingArea>
<KitchenArea>10.0</KitchenArea>
<RoomDefinitions>
<Room><Area>20</Area></Room>
<Room><Area>16</Area></Room>
</RoomDefinitions>
<FloorNumber>5</FloorNumber>
<JKSchema>
<Id>10001</Id>
<Name>ЖК Солнечный</Name>
<House>
<Id>20001</Id>
<Name>Корпус 1</Name>
<Flat>
<FlatNumber>45</FlatNumber>
<SectionNumber>2</SectionNumber>
<FlatType>primary</FlatType>
</Flat>
</House>
</JKSchema>
<LoggiasCount>1</LoggiasCount>
<BalconiesCount>1</BalconiesCount>
<LayoutPhoto>
<FullUrl>https://example.com/flat-layout.jpg</FullUrl>
<IsDefault>true</IsDefault>
<PhotoType>realtyObjectLayout</PhotoType>
</LayoutPhoto>
<Photos>
<PhotoSchema>
<FullUrl>https://example.com/flat1.jpg</FullUrl>
<IsDefault>false</IsDefault>
<PhotoType>realtyObject</PhotoType>
</PhotoSchema>
<PhotoSchema>
<FullUrl>https://example.com/flat2.jpg</FullUrl>
<IsDefault>false</IsDefault>
<PhotoType>realtyFloorLayout</PhotoType>
</PhotoSchema>
</Photos>
<Decoration>fine</Decoration>
<ProjectDeclarationUrl>https://example.com/declaration.pdf</ProjectDeclarationUrl>
<WindowsViewType>yard</WindowsViewType>
<WindowsViewType>street</WindowsViewType>
<WindowsViewType>river</WindowsViewType>
<SeparateWcsCount>1</SeparateWcsCount>
<CombinedWcsCount>1</CombinedWcsCount>
<HasRamp>true</HasRamp>
<Title>2-комн. квартира · 60 м² · 5 этаж</Title>
<Building>
<CeilingHeight>2.8</CeilingHeight>
</Building>
<BargainTerms>
<Price>11500000</Price>
<Currency>rur</Currency>
<MortgageAllowed>true</MortgageAllowed>
<SaleType>fz214</SaleType>
</BargainTerms>
</object>
</feed>