API для партнеров

В этом разделе описывается взаимодействие партнеров и сервиса RealtyPult. API построено на обмене XML файлами. Существует 2 основных типа XML файла:

  • 1. XML фид с объявлениями которые необходимо (формат)
  • 2. XML отчет о размещении объявлений на площадке партнера (формат)

Для упрощения интеграции рекомендуется использовать API библиотеки на NodeJS и PHP.

Формат XML отчета

Структура тегов

Название тега Атрибуты тега Тип данных Значение / Пример заполнения Описание
objects Корневой элемент
object Тег, описывающий одно объявление
id Строка 5738d1a01b699a01207b869a Идентификатор объявления в базе RealtyPult
url Ссылка https://site.ru/demo-object/1 Ссылка на объявление размещенное на портале
views Число 116 Сумарное число просмотров объявления на портале
similarUrl Ссылка https://site.ru/duplicate-object/1 Ссылка на уже размещенное объявление на портале
rejectReason Строка Слишком низкая цена для этого объявления Причина отказа в публикации объявления
error Строка Произошла ошибка запроса к базе данных Сообщение об ошибке в случае если объявление импортировать не удалось (техническая ошибка)

XSD схема

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="objects">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="object" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:choice minOccurs="1" maxOccurs="1">
              <xs:group ref="successGroup"/>
              <xs:group ref="errorGroup"/>
              <xs:group ref="similarGroup"/>
              <xs:group ref="rejectedGroup"/>
            </xs:choice>
            <xs:attribute type="internalId" name="id" use="required"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:group name="successGroup">
    <xs:sequence>
      <xs:element name="url" minOccurs="1" maxOccurs="1">
        <xs:simpleType>
          <xs:restriction base="xs:anyURI">
            <xs:pattern value="https?://.+"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element type="xs:unsignedInt" name="views" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
  </xs:group>

  <xs:group name="errorGroup">
    <xs:sequence>
      <xs:element type="xs:string" name="error" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
  </xs:group>

  <xs:simpleType name="internalId">
    <xs:restriction base="xs:string">
      <xs:pattern value="[0-9a-fA-F]{24}"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:group name="similarGroup">
    <xs:sequence>
      <xs:element type="xs:string" name="similarUrl" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
  </xs:group>

  <xs:group name="rejectedGroup">
    <xs:sequence>
      <xs:element type="xs:string" name="rejectReason" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
  </xs:group>

</xs:schema>

Пример отчета

<?xml version="1.0" encoding="UTF-8" ?>

<objects>
  <object id="5738d1a01b699a01207b869a">
    <url>http://site.ru/object/1</url>
    <views>5</views>
  </object>
  <object id="5738d1a01b699a01207b869c">
    <error>
      Неудалось распознать адрес объекта
    </error>
  </object>
  <object id="5738d1a01b699a01207b869b">
    <url>http://site.ru/object/2</url>
    <views>116</views>
  </object>
  <object id="5738d1a01b699a01207b869f">
    <rejectReason>Слишком низкая цена для этого объявления</rejectReason>
  </object>
  <object id="5738d1a01b699a01207b869d">
    <url>http://site.ru/object/3</url>
    <views>39</views>
  </object>
  <object id="5738d1a01b699a01207b869e">
    <similarUrl>http://site.ru/object/5</similarUrl>
  </object>
</objects>

Формат XML фида

Основные теги, для всех типов объявлений
Название тега Атрибуты тега Тип данных Значение / Пример заполнения Описание
root Корневой элемент.
version Значение Строго 2.0 Версия формата.
object Тег, описывающий одно объявление.
id Строка ID объявления в базе источнике.
address Тег, описывающий месторасположение объекта.
searchString Строка <searchString>
  Нижегородская область, Редькино
</searchString>


<searchString>
  Нижний Новгород, ул. Минина, д. 9 корп. 2
</searchString>
Строка для автоматического поиска адреса объекта.

Тег обязателен для импорта объявлений на портал realtypult.ru

Полный адрес объекта будет определен автоматически а теги "geo*" проигнорированы.
geoCountry Строка <geoCountry>Россия</geoCountry> Страна.  Обязятелен если не задан searchString.
geoObl Строка <geoObl>Нижегородская область</geoObl> Область.  Обязятелен если не задан searchString. Не допускаются сокращения топонимов.
geoRaion Строка <geoRaion>Богородский район</geoRaion> Район области.  Обязателен в случае деревни, села и если не задан searchString. Не допускаются сокращения топонимов.
geoPlace Строка <geoPlace>Нижний Новгород</geoPlace> Город или населенный пункт.  Обязятелен если не задан searchString.
geoStreet Строка <geoStreet>улица Переходникова</geoStreet> Улица,  обязателен только для городов и если не задан searchString. Не допускаются сокращения топонимов.
geoHouse Строка <geoHouse>29</geoHouse> Номер дома, включая корпус или строение.
geoLongitude Число <geoLongitude>
  43.844020
</geoLongitude>
Географическая долгота объекта.
geoLatitude Число <geoLatitude>
  56.048716
</geoLatitude>
Географическая широта объекта.
geoMetro Строка <geoMetro>
  Бабушкинская
</geoMetro>
Ближайшая станция метро,  обязателен только для Москвы и Санкт-Петербурга и если не задан searchString.
geoDistance Число <geoDistance>
  1352
</geoDistance>
Расстояние до метро в метрах.
user Тег, содержащий контактную информацию.
name Строка <name>Светлана</name> Имя контактного лица.
phone Строка <phone>9200234451</phone> Контактный телефон из 10 цифр. Для каждого пользователя это поле должно быть уникальным.
email E-mail <email>[email protected]</email> E-mail адрес. Для каждого пользователя это поле должно быть уникальным.
image URL <image>https://realtypult.ru/images/user-default-image.png</image> Аватар пользователя.
type Тип пользователя <type>1</type> Тип пользователя. Строго из списка:

1 - посредник
2 - собственник

По умолчанию - 1
companyName Название организации <companyName>
  Наша недвижимость
</companyName>
Наименование организации.
companySite URL <companySite>
  http://company.site.ru
</companySite>
Веб-сайт организации.
companyPhone Строка <companyPhone>
  89100000000
</companyPhone>
Телефон организации.
companyEmail E-mail <companyEmail>
  [email protected]
</companyEmail>
E-mail организации.
offerType Значение <offerType>1</offerType> Тип сделки. Строго из списка:

1 - Продажа
2 - Аренда
objectType Значение <objectType>2</objectType> Тип недвижимости. Строго из списка:

1 - Квартира
2 - Комната
3 - Дом/Дача/Коттедж/Таунхаус
4 - Земля
5 - Гараж/Машиноместо
6 - Коммерческая недвижимость
price Число <price>2000000</price> Цена продажи или цена аренды.
description Строка <description>
  Квартира в центре города, 10 минут до набережной.
</description>
Текстовое описание объекта. Минимум 50 знаков.
images Тег, содержащий информацию об изображениях.
image URL <image>
  http://site.com/image_1.jpg
</image>
Тег, описывающий изображение. Может встречаться несколько раз.
youtubeUrl URL <youtubeUrl>
  https://www.youtube.com/embed/XXXXXXXXXXX
</youtubeUrl>
Видео на YouTube.
url URL <url>
  http://site.com/flat_1.html
</url>
Адрес объекта недвижимости на сайте источнике.
premium Значение <premium>1</premium> Премиум размещение. Строго из списка:

0 - нет
1 - да

По умолчанию - 0
createdAt Дата и время <createdAt>
  2016-05-02T19:09:57+03:00
</createdAt>
Дата и время создания объявления.
updatedAt Дата и время <updatedAt>
  2016-05-05T12:04:12+03:00
</updatedAt>
Дата и время последнего обновления объявления.
Теги, необходимые для описания квартиры, добавляются в тег <object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
houseType Значение <houseType>4</houseType>
1 - Улучшенное
2 - Хрущевка
3 - Стандартное
4 - Брежневка
5 - Сталинка
6 - Гостинка/Малогабаритка
7 - Народная стройка
8 - Старый фонд
9 - Элитная
Тип жилья.
floor Число <floor>2</floor> Этаж.
floors Число <floors>10</floors> Этажность здания.
rooms Число <rooms>3</rooms> Общее число комнат.
squareTotal Число <squareTotal>120</squareTotal> Общая площадь.
squareLiving Число <squareLiving>50</squareLiving> Жилая площадь.
squareKitchen Число <squareKitchen>50</squareKitchen> Площадь кухни.
newBuilding Значение 2 <newBuilding>1</newBuilding>
1 - Новостройка
2 - Вторичное жилье
Признак новостройки.
rentType Значение 2 <rentType>1</rentType>
1 - Посуточная
2 - Долгосрочная
Только для аренды. Тип аренды.
agentCommission Число от 0 до 100 100 <agentCommission>100</agentCommission> Только для аренды. Комиссия агенту в процентах.
mortgagePossible Значение <mortgagePossible>1</mortgagePossible>
1 - Да
2 - Нет
Ипотека
rentDeposit Число, сумма депозита <rentDeposit>20000</rentDeposit> Величина депозита
readyDate Дата <readyDate>2014-08-05</readyDate> Для новостроек, дата сдачи. В формате YYYY-MM-DD.
yearBuild Дата <yearBuild>1976</yearBuild> Дата постройки здания. В формате YYYY.
wallMaterial Значение <wallMaterial>4</wallMaterial>
1 - Кирпичный
2 - Монолитный
3 - Панельный
4 - Блочный
5 - Кирпично-монолитный
6 - Пеноблочный
7 - Деревянный (брусовой)
Материал стен.
seriesBuilding Строка <seriesBuilding>П-3М</seriesBuilding> Серия здания (только для серийных зданий). Примеры: П-3М, П-44, П-3, П-43, П-4.
squareLivingRooms Строка <squareLivingRooms>10/23/9</squareLivingRooms> Площади жилых комнат разделенные "/".
layoutType Значение 3 <layoutType>4</layoutType>
1 - Изолированная
2 - Смежная
3 - Смежно-изолированная
4 - Свободная
Планировка.
ceilingHeight Число с плавающей точкой <ceilingHeight>2.7</ceilingHeight> Высота потолков.
wcType Значение <wcType>2</wcType>
1 - Совмещенный
2 - Раздельный
3 - 2
4 - 3
5 - 4
Тип / количество санузлов.
repairType Значение 1 <repairType>3</repairType>
1 - Хорошее
2 - Отличное
3 - Евростандарт
4 - Без отделки
5 - Косметический ремонт
6 - Нужен косметический ремонт
7 - Нужен капитальный ремонт
Состояние объекта / Ремонт.
floorMaterial Значение <floorMaterial>3</floorMaterial>
1 - Дерево
2 - Линолеум
3 - Паркет
4 - Ковролин
5 - Ламинат
Материал пола.
overlapMaterial Значение <overlapMaterial>3</overlapMaterial>
1 - Монолитные
2 - Жб
3 - Дерево
4 - Смешанные
5 - Иное
Материал перекрытий.
windowType Значение <windowType>3</windowType>
1 - Деревянные
2 - Пластиковые
3 - Деревянный стеклопакет
4 - Пластиковый стеклопакет
Тип окон.
viewType Значение <viewType>3</viewType>
1 - Улица
2 - Двор
3 - Двор и улица
Вид из окон.
parkingType Значение <parkingType>3</parkingType>
1 - Стихийная
2 - Охраняемая
3 - Неохраняемая
4 - Подземная
Тип парковки.
balconyType Значение <balconyType>3</balconyType>
1 - Балкон
2 - Лоджия
3 - Балкон и лоджия
Тип балкона.
passengerLift Значение <passengerLift>1</passengerLift>
1 - Да
2 - Нет
Пассажирский лифт.
serviceLift Значение <serviceLift>1</serviceLift>
1 - Да
2 - Нет
Грузовой лифт.
television Значение <television>1</television>
1 - Да
2 - Нет
Телевидение.
rubbishChute Значение <rubbishChute>1</rubbishChute>
1 - Да
2 - Нет
Наличие мусоропровода.
furniture Значение <furniture>1</furniture>
1 - Да
2 - Нет
Наличие мебели.
airConditioner Значение <airConditioner>1</airConditioner>
1 - Да
2 - Нет
Наличие кондиционера.
householdAppliances Значение <householdAppliances>1</householdAppliances>
1 - Да
2 - Нет
Наличие бытовой техники.
phone Значение <phone>1</phone>
1 - Да
2 - Нет
Наличие телефона.
internet Значение <internet>1</internet>
1 - Да
2 - Нет
Наличие интернета.
Теги, необходимые для описания комнаты, добавляются в тег<object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
houseType Значение <houseType>4</houseType>
1 - Улучшенное
2 - Хрущевка
3 - Стандартное
4 - Брежневка
5 - Сталинка
6 - Гостинка/Малогабаритка
7 - Народная стройка
8 - Старый фонд
9 - Элитная
Тип жилья
floor Число <floor>2</floor> Этаж
floors Число <floors>10</floors> Этажность здания
rooms Число <rooms>3</rooms> Общее число комнат
squareRoom Число <squareRoom>15</squareRoom> Площадь комнаты
squareTotal Число <squareTotal>120</squareTotal> Общая площадь квартиры
squareLiving Число <squareLiving>50</squareLiving> Жилая площадь
squareKitchen Число <squareKitchen>50</squareKitchen> Площадь кухни
roomsInDeal Число 1 <roomsInDeal>2</roomsInDeal> Число комнат учавствующих в сделке
squareLivingRooms Строка <squareLivingRooms>10/23/9</squareLivingRooms> Площади жилых комнат разделенные "/"
layoutType Значение <layoutType>4</layoutType>
1 - Изолированная
2 - Смежная
3 - Смежно-изолированная
4 - Свободная
Планировка
ceilingHeight Число с плавающей точкой <ceilingHeight>2.7</ceilingHeight> Высота потолков
wcType Значение <wcType>2</wcType>
1 - Совмещенный
2 - Раздельный
3 - 2
4 - 3
5 - 4
Тип / количество санузлов
repairType Значение <repairType>3</repairType>
1 - Хорошее
2 - Отличное
3 - Евростандарт
4 - Без отделки
5 - Косметический ремонт
6 - Нужен косметический ремонт
7 - Нужен капитальный ремонт
Состояние объекта / Ремонт
floorMaterial Значение <floorMaterial>3</floorMaterial>
1 - Дерево
2 - Линолеум
3 - Паркет
4 - Ковролин
5 - Ламинат
Материал пола
overlapMaterial Значение <overlapMaterial>3</overlapMaterial>
1 - Монолитные
2 - Жб
3 - Дерево
4 - Смешанные
5 - Иное
Материал перекрытий
windowType Значение <windowType>3</windowType>
1 - Деревянные
2 - Пластиковые
3 - Деревянный стеклопакет
4 - Пластиковый стеклопакет
Тип окон
viewType Значение <viewType>3</viewType>
1 - Улица
2 - Двор
3 - Двор и улица
Вид из окон
balconyType Значение <balconyType>3</balconyType>
1 - Балкон
2 - Лоджия
3 - Балкон и лоджия
Тип балкона
passengerLift Значение <passengerLift>1</passengerLift>
1 - Да
2 - Нет
Пассажирский лифт
serviceLift Значение <serviceLift>1</serviceLift>
1 - Да
2 - Нет
Грузовой лифт
television Значение <television>1</television>
1 - Да
2 - Нет
Телевидение
rubbishChute Значение <rubbishChute>1</rubbishChute>
1 - Да
2 - Нет
Мусоропровод
furniture Значение <furniture>1</furniture>
1 - Да
2 - Нет
Мебель
airConditioner Значение <airConditioner>1</airConditioner>
1 - Да
2 - Нет
Кондиционер
householdAppliances Значение <householdAppliances>1</householdAppliances>
1 - Да
2 - Нет
Бытовая техника
phone Значение <phone>1</phone>
1 - Да
2 - Нет
Телефон
internet Значение <internet>1</internet>
1 - Да
2 - Нет
Интернет
rentType Значение 2 <rentType>1</rentType>
1 - Посуточная
2 - Долгосрочная
Только для аренды. Тип аренды
agentCommission Число от 0 до 100 100 <agentCommission>100</agentCommission> Только для аренды. Комиссия агенту в процентах.
rentDeposit Число, сумма депозита <rentDeposit>20000</rentDeposit> Величина депозита
mortgagePossible Значение <mortgagePossible>1</mortgagePossible>
1 - Да
2 - Нет
Ипотека
yearBuild Дата <yearBuild>1976</yearBuild> Дата постройки здания. В формате YYYY
parkingType Значение <parkingType>3</parkingType>
1 - Стихийная
2 - Охраняемая
3 - Неохраняемая
4 - Подземная
Тип парковки
wallMaterial Значение <wallMaterial>4</wallMaterial>
1 - Кирпичный
2 - Монолитный
3 - Панельный
4 - Блочный
5 - Кирпично-монолитный
6 - Пеноблочный
7 - Деревянный (брусовой)
Материал стен
seriesBuilding Строка <seriesBuilding>П-3М</seriesBuilding> Серия здания (только для серийных зданий). Примеры: П-3М, П-44, П-3, П-43, П-4
Теги, необходимые для описания дома / дачи / коттеджа, добавляются в тег <object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
buildingType Значение <buildingType>2</buildingType>
1 - Дом
2 - Коттедж
3 - Дача
4 - Таунхаус
5 - 1/2 Дома
Тип дома
floors Число <floors>10</floors> Этажность здания
rooms Число <rooms>3</rooms> Общее число комнат
squareTotal Число <squareTotal>120</squareTotal> Общая площадь дома
squareLiving Число <squareLiving>50</squareLiving> Жилая площадь
squareKitchen Число <squareKitchen>50</squareKitchen> Площадь кухни
squareLand Число <squareLand>10</squareLand> Площадь участка в сотках
floorMaterial Значение <floorMaterial>3</floorMaterial>
1 - Дерево
2 - Линолеум
3 - Паркет
4 - Ковролин
5 - Ламинат
Материал пола
overlapMaterial Значение <overlapMaterial>3</overlapMaterial>
1 - Монолитные
2 - Жб
3 - Дерево
4 - Смешанные
5 - Иное
Материал перекрытий
windowType Значение <windowType>3</windowType>
1 - Деревянные
2 - Пластиковые
3 - Деревянный стеклопакет
4 - Пластиковый стеклопакет
Тип окон
toiletType Значение <toiletType>2</toiletType>
1 - Дома
2 - Вне дома
Туалет
heating Значение <heating>1</heating>
1 - Да
2 - Нет
Отопление
gas Значение <gas>1</gas>
1 - Да
2 - Нет
3 - Возможно подключение
Газ
electricity Значение <electricity>1</electricity>
1 - Да
2 - Нет
3 - Возможно подключение
Электричество
water Значение <water>1</water>
1 - Да
2 - Нет
3 - Возможно подключение
Водопровод
sewerage Значение <sewerage>1</sewerage>
1 - Да
2 - Нет
3 - Возможно подключение
Канализация
permanentResidence Значение <permanentResidence>1</permanentResidence>
1 - Да
2 - Нет
ПМЖ
sauna Значение <sauna>1</sauna>
1 - Да
2 - Нет
Баня, сауна
garage Значение <garage>1</garage>
1 - Да
2 - Нет
Гараж
newBuilding Значение 2 <newBuilding>1</newBuilding>
1 - Новостройка
2 - Вторичное жилье
Признак новостройки
rentType Значение 2 <rentType>1</rentType>
1 - Посуточная
2 - Долгосрочная
Только для аренды. Тип аренды.
agentCommission Число от 0 до 100 100 <agentCommission>100</agentCommission> Только для аренды. Комиссия агенту в процентах.
rentDeposit Число, сумма депозита <rentDeposit>20000</rentDeposit> Величина депозита
mortgagePossible Значение <mortgagePossible>1</mortgagePossible>
1 - Да
2 - Нет
Ипотека
readyDate Дата <readyDate>2014-08-05</readyDate> Для новостроек, дата сдачи. В формате YYYY-MM-DD
yearBuild Дата <yearBuild>1976</yearBuild> Дата постройки здания. В формате YYYY
wallMaterial Значение <wallMaterial>4</wallMaterial>
1 - Кирпичный
2 - Монолитный
3 - Панельный
4 - Блочный
5 - Кирпично-монолитный
6 - Пеноблочный
7 - Деревянный (брусовой)
Материал стен
Теги, необходимые для описания земли, добавляются в тег<object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
landType Значение <landType>2</landType>
1 - Поселение
2 - Промназначение
Тип земель
squareLand Число <squareLand>10</squareLand> Площадь участка в сотках
heating Значение <heating>1</heating>
1 - Да
2 - Нет
Отопление
gas Значение <gas>1</gas>
1 - Да
2 - Нет
3 - Возможно подключение
Газ
electricity Значение <electricity>1</electricity>
1 - Да
2 - Нет
3 - Возможно подключение
Электричество
water Значение <water>1</water>
1 - Да
2 - Нет
3 - Возможно подключение
Водопровод
sewerage Значение <sewerage>1</sewerage>
1 - Да
2 - Нет
3 - Возможно подключение
Канализация
Теги, необходимые для описания гаража, добавляются в тег<object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
garageType Значение <garageType>4</garageType>
1 - Капитальный
2 - Железобетонный
3 - Металлический
4 - Машиноместо
Тип гаража
squareTotal Число <squareTotal>120</squareTotal> Общая площадь гаража
Теги, необходимые для описания коммерческой недвижимости, добавляются в тег<object>...</object>
Название тега Тип данных По умолчанию Значение / Пример заполнения Описание
commercialType Значение <commercialType>2</commercialType>
1 - Склад
2 - Производственное помещение
3 - Торговое помещение
4 - Офис
5 - Другое
6 - Автосервис
7 - Готовый бизнес
8 - Помещения свободного назначения
9 - Отель
10 - Земли коммерческого назначения
Тип коммерческой недвижимости
squareTotal Число <squareTotal>120</squareTotal> Общая площадь
agentCommission Число от 0 до 100 100 <agentCommission>100</agentCommission> Только для аренды. Комиссия агенту в процентах.
rentDeposit Число, сумма депозита <rentDeposit>20000</rentDeposit> Величина депозита