Документация по работе с API Real Estate CRM

Адрес для обращений к API

http://api.recrm.ru/xml/ - если вы хотите получать ответ в формате XML

http://api.recrm.ru/json/ - если вы хотите получать ответ в формате JSON

Запросы к API

Страны

получение списка стран:

http://api.recrm.ru/{формат}/countries?key={ключ}
пример ответа в формате XML:
<response>
  <countries>
    <country id="1" name="Австралия" />
    <country id="2" name="Австрия" />
    <country id="3" name="Андорра" />
    ...
  </countries>
</response>
пример ответа в формате JSON:
{
	"countries":[
		{"id":1,"name":"Австралия"},
		{"id":2,"name":"Австрия"},
		{"id":3,"name":"Андорра"},
		{"id":4,"name":"Белоруссия"},
		...
	]
}

Города

получение списка активных городов:

http://api.recrm.ru/{формат}/cities?key={ключ}
пример ответа в формате XML:
<response>
  <cities>
    <city id="28" name="Москва" name_prepositional="Москве" country_id="0" region_id="0" region_district_id="0" />
    <city id="259" name="Санкт-Петербург" name_prepositional="Санкт-Петербурге" country_id="0" region_id="0" region_district_id="0" />
    <city id="219" name="Сидней" name_prepositional="Сиднее" country_id="1" region_id="0" region_district_id="0" />
    ...
  </cities>
</response>
пример ответа в формате JSON:
{
	"cities":[
		{"id":28,"name":"Москва",name_prepositional="Москве",country_id":0,region_id:0,region_district_id:0},
		{"id":259,"name":"Санкт-Петербург",name_prepositional="Санкт-Петербурге","country_id":0,region_id:0,region_district_id:0},
		{"id":219,"name":"Сидней",name_prepositional="Сиднее","country_id":1,region_id:0,region_district_id:0},
		...
	]
}

Районы

получение списка районов для указанного города:

http://api.recrm.ru/{формат}/districts?key={ключ}&city_id={ID города}
пример ответа в формате XML:
<response>
  <districts>
    <district id="26" name="Восточное измайлово" name_prepositional="Восточном измайлово" city_id="28" />
    <district id="27" name="Чертаново" name_prepositional="Чертаново" city_id="28" />
    <district id="28" name="Арбат" name_prepositional="Арбате" city_id="28" />
    ...
  </districts>
</response>
пример ответа в формате JSON:
{
	"districts":[
		{"id":26,"name":"Восточное измайлово",name_prepositional="Восточном измайлово",city_id=28},
		{"id":27,"name":"Чертаново",name_prepositional="Чертаново",city_id=28},
		{"id":28,"name":"Арбат",name_prepositional="Арбате",city_id=28},
		...
	]
}

Улицы

получение списка всех улиц:

http://api.recrm.ru/{формат}/street/allstreets?key={ключ}
пример ответа в формате XML:
<response>
  <streets>
    <street id="26" title="Берзина" type="0" city_id="272" />
    <street id="27" title="Колымское" type="11" city_id="272" />
    <street id="28" title="Флотская" type="0" city_id="272" />
    ...
  </streets>
</response>
пример ответа в формате JSON:
{
	"streets":[
		{"id":26,"name":"Берзина","type":0,"city_id"=272},
		{"id":27,"name":"Колымское","type":11,"city_id"=272},
		{"id":28,"name":"Флотская","type":0,"city_id"=272},
		...
	]
}

получение списка улиц для указанного города:

http://api.recrm.ru/{формат}/street/streets?key={ключ}&city_id={ID города}
пример ответа в формате XML:
<response>
  <streets>
    <street id="26" title="Берзина" type="0" city_id="272" />
    <street id="27" title="Колымское" type="11" city_id="272" />
    <street id="28" title="Флотская" type="0" city_id="272" />
    ...
  </streets>
</response>
пример ответа в формате JSON:
{
	"streets":[
		{"id":26,"name":"Берзина","type":0,"city_id"=272},
		{"id":27,"name":"Колымское","type":11,"city_id"=272},
		{"id":28,"name":"Флотская","type":0,"city_id"=272},
		...
	]
}

Добавление улицы:

Для создания заявки нужно выполнить POST-запрос на url http://api.recrm.ru/{формат}/street/add
В качестве параметров необходимо передать следующие данные:
Имя поля Описание поля
key ключ API
city_id ID города
title название улицы
street_type_id ID типа улицы
Тип улицы ID типа улицы
Улица 0
Бульвар 1
Аллея 2
Переулок 3
Проспект 4
Парк 5
Переезд 6
Площадь 7
Платформа 8
Проезд 9
Тупик 10
Шоссе 11
Набережная 12
мкр. (микрорайон) 13

Станции метро

получение списка станций метро для указанного города:

http://api.recrm.ru/{формат}/metro/stations?key={ключ}&city_id={ID города}
пример ответа в формате XML:
<response>
  <metro_stations>
    <metro_station id="235" name="Авиамоторная" metro_line_id="0" city_id="199"/>
    <metro_station id="236" name="Автозаводская" metro_line_id="0" city_id="199"/>
    <metro_station id="237" name="Академическая" metro_line_id="0" city_id="199"/>
    <metro_station id="238" name="Александровский сад" metro_line_id="0" city_id="199"/>
    <metro_station id="239" name="Алексеевская" metro_line_id="0" city_id="199"/>
    <metro_station id="240" name="Алтуфьево" metro_line_id="0" city_id="199"/>
    ...
  </metro_stations>
</response>
пример ответа в формате JSON:
{
	"metro_stations":[
		{"id":235,"name":"Авиамоторная","metro_line_id":0,city_id:199},
		{"id":236,"name":"Автозаводская","metro_line_id":0,city_id:199},
		{"id":237,"name":"Академическая","metro_line_id":0,city_id:199},
		{"id":238,"name":"Александровский сад","metro_line_id":0,city_id:199},
		{"id":239,"name":"Алексеевская","metro_line_id":0,city_id:199},
		{"id":240,"name":"Алтуфьево","metro_line_id":0,city_id:199},
		...
	]
}

Шоссе

получение списка шоссе для указанного города:

http://api.recrm.ru/{формат}/routes/bycity?key={ключ}&city_id={ID города}
пример ответа в формате XML:
<response>
  <routes>
    <route id="1" name="Алтуфьевское шоссе" city_id="214" region_id="42"/>
    <route id="2" name="Боровское шоссе" city_id="214" region_id="42"/>
    <route id="3" name="Быковское шоссе" city_id="214" region_id="42"/>
    ...
  </routes>
</response>
пример ответа в формате JSON:
{
  	"routes":[
  		{"city_id":214,"id":1,"name":"Алтуфьевское шоссе","region_id":42},
  		{"city_id":214,"id":2,"name":"Боровское шоссе","region_id":42},
  		{"city_id":214,"id":3,"name":"Быковское шоссе","region_id":42},
		...
	]
}

Типы недвижимости

получение списка групп типов:

http://api.recrm.ru/{формат}/estatetypes/groups?key={ключ}
пример ответа в формате XML:
<response>
  <groups>
    <group id="2" name="дома, таунхаусы" />
    <group id="4" name="земля для строительства коммерческой недвижимости" />
    <group id="6" name="офисы" />
    <group id="7" name="торговая недвижимость" />
    <group id="8" name="склады" />
    <group id="9" name="инвестпроекты" />
    <group id="10" name="квартиры" />
    <group id="12" name="сады, дачи" />
    <group id="13" name="гаражи, паркинги" />
    <group id="14" name="участки для строительства жилой недвижимости" />
  </groups>
</response>
пример ответа в формате JSON:
{
	"groups":[
		{"id":2,"name":"дома, таунхаусы"},
		{"id":4,"name":"земля для строительства коммерческой недвижимости"},
		{"id":6,"name":"офисы"},
		{"id":7,"name":"торговая недвижимость"},
		{"id":8,"name":"склады"},
		{"id":9,"name":"инвестпроекты"},
		{"id":10,"name":"квартиры"},
		{"id":12,"name":"сады, дачи"},
		{"id":13,"name":"гаражи, паркинги"},
		{"id":14,"name":"участки для строительства жилой недвижимости"}
	]
}

получение списка типов указанной группы:

http://api.recrm.ru/{формат}/estatetypes?key={ключ}&group_id={ID группы}
пример ответа в формате XML:
<response>
  <types>
    <type id="2" group_id="7" name="торговые помещения" />
    <type id="50" group_id="7" name="помещения под общепит" />
    <type id="64" group_id="7" name="доходный дом" />
    <type id="65" group_id="7" name="кафе, ресторан" />
    <type id="66" group_id="7" name="отель, гостиница" />
    <type id="67" group_id="7" name="магазин" />
  </types>
</response>
пример ответа в формате JSON:
{
	"types":[
		{"group_id":7,"id":2,"name":"торговые помещения"},
		{"group_id":7,"id":50,"name":"помещения под общепит"},
		{"group_id":7,"id":64,"name":"доходный дом"},
		{"group_id":7,"id":65,"name":"кафе, ресторан"},
		{"group_id":7,"id":66,"name":"отель, гостиница"},
		{"group_id":7,"id":67,"name":"магазин"}
	]
}

Справочники

Список типов отделки:

http://api.recrm.ru/{формат}/finish/all?key={ключ}
пример ответа в формате XML:
<response>
  <finishes>
    <finish id="8" name="без отделки"/>
    <finish id="6" name="евроремонт"/>
    <finish id="7" name="евроремонт с дизайном"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
      	"finishes":[
      		{"id":8,"name":"без отделки"},
      		{"id":6,"name":"евроремонт"},
      		{"id":7,"name":"евроремонт с дизайном"},
		...
	]
}

Список материалов стен:

http://api.recrm.ru/{формат}/wallmaterials/all?key={ключ}
пример ответа в формате XML:
<response>
  <wall_materials>
    <wall_material id="1" name="блочное"/>
    <wall_material id="9" name="брус"/>
    <wall_material id="6" name="деревянное"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
        "wall_materials":[
        	{"id":1,"name":"блочное"},
        	{"id":9,"name":"брус"},
        	{"id":6,"name":"деревянное"},
		...
	]
}

Список типов кондиционирования:

http://api.recrm.ru/{формат}/dictionary/values?type=5&key={ключ}
пример ответа в формате XML:
<response>
  <values>
    <value id="15" type="5" title="есть"/>
    <value id="16" type="5" title="нет"/>
    <value id="17" type="5" title="централизованное"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
      	"values":[
      		{"id":15,"title":"есть","type":5},
      		{"id":16,"title":"нет","type":5},
      		{"id":17,"title":"централизованное","type":5},
		...
	]
}

Список типов водоснабжения:

http://api.recrm.ru/{формат}/dictionary/values?type=12&key={ключ}
пример ответа в формате XML:
<response>
  <values>
    <value id="43" type="12" title="есть"/>
    <value id="44" type="12" title="нет"/>
    <value id="45" type="12" title="центральное"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
      	"values":[
      		{"id":43,"title":"есть","type":12},
      		{"id":44,"title":"нет","type":12},
      		{"id":45,"title":"центральное","type":12},
		...
	]
}

Список типов газоснабжения:

http://api.recrm.ru/{формат}/dictionary/values?type=14&key={ключ}
пример ответа в формате XML:
<response>
  <values>
    <value id="67" type="14" title="есть"/>
    <value id="68" type="14" title="нет"/>
    <value id="69" type="14" title="центральный"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
      	"values":[
      		{"id":67,"title":"есть","type":14},
      		{"id":68,"title":"нет","type":14},
      		{"id":69,"title":"центральный","type":14},
		...
	]
}

Список типов электроснабжения:

http://api.recrm.ru/{формат}/dictionary/values?type=10&key={ключ}
пример ответа в формате XML:
<response>
  <values>
    <value id="30" type="14" title="есть"/>
    <value id="31" type="14" title="нет"/>
    <value id="32" type="14" title="220В"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
      	"values":[
      		{"id":30,"title":"есть","type":10},
      		{"id":31,"title":"нет","type":10},
      		{"id":32,"title":"220В","type":10},
		...
	]
}

Список типов канализации:

http://api.recrm.ru/{формат}/dictionary/values?type=11&key={ключ}
пример ответа в формате XML:
<response>
  <values>
    <value id="38" type="14" title="есть"/>
    <value id="39" type="14" title="нет"/>
    <value id="40" type="14" title="центральная"/>
    ...
  </finishes>
</response>
пример ответа в формате JSON:
{
        "values":[
        	{"id":38,"title":"есть","type":11},
        	{"id":39,"title":"нет","type":11},
        	{"id":40,"title":"центральная","type":11},
		...
	]
}

Объекты недвижимости

получение подробной информации по объекту:

http://api.recrm.ru/{формат}/estate/info?key={ключ}&id={ID объекта недвижимости}
Параметры запроса
id ID объекта недвижимости (обязательный параметр)
description_format Формат, в котором будет передано описание объекта. Возможные значения: 0 - plain text, 1 - HTML.
Если параметр не указан, будет использоваться формат по умолчанию - plain text.
Передача HTML-разметки (при выборе соответствующего формата) выполняется в экранированном виде
Список возможных значений полей объекта
Имя поля Описание поля
id ID объекта недвижимости
hidden Является ли объект скрытым - true/false. Если объект скрыт, то он не должен отображаться на сайте
hot Является ли объект горячим предложением - true/false
title название объекта
latitude географическая широта
longitude географическая долгота
zoom значение zoom для отображения на карте
country_id ID страны
city_id ID города
district_id ID района
metro_id ID станции метро
agent_id ID агента
type Тип недвижимости
type_id ID типа недвижимости
deal Тип сделки
lease_type Тип аренды //посуточная аренда/аренда на несколько месяцев (до года)/долгосрочная аренда (от года)
sublease Субаренда
country Страна
city Город
lock Объект заблокирован или нет
place Населенный пункт
district Район
metro_station Метро
metro_walk_time Расстояние пешком до метро, мин.
metro_transport_time Расстояние транспортом до метро, мин.
route Ближайшее шоссе
finish Отделка
area Общая площадь
office_area Офисные помещения
ground_area Площадь земельного участка
live_area Жилая площадь
kitchen_area Площадь кухни
rooms Кол-во комнат //для зарубежной недвижимости - кол-во спален// В это поле также возвращаются дополнительные значения: 101-студия, 102 - свободная планировка, 103- доля в квартире, 104 - койко-место.
floor Этаж // либо число, либо: подвал/цокольный/мансардный
purpose Назначение проекта
location Местоположение
legal_status Юридический статус земельного участка
condition Текущее состояние проекта
offer_type Тип предложения
financial_terms Финансовые условия
price_total Цена за весь объект
price_per_meter Цена за метр
currency валюта (Rub/Euro/Usd)
comission Комиссия (значение отображается только в том случае, если в параметрах объекта в CRM включена галочка "Отображать значение комиссионных в PDF-презентации и на сайте")
building_stage Стадия строительства
build_date Срок сдачи
floors_total Этажность
balcony Балкон/лоджия
balcony_area Балкон/терасса
separated_bathroom Санузел //раздельный/совмещенный
bathrooms_count Кол-во санузлов
ceiling_height Высота потолка
prepay_month Количество месяцев предоплаты
deposit Наличие страхового депозита
furniture Наличие мебели в жилых комнатах
furniture_kitchen Наличие мебели на кухне
tv Наличие телевизора
washing_machine Наличие стиральной машины
fridge Наличие холодильника
kids_allowed Возьмут с детьми
pets_allowed Возьмут с животными
view_from_window Вид из окна
infrastructure Инфраструктура района
phone Оператор телефонной связи
internet Интернет-провайдер
repair_date Дата проведения последнего ремонта
distance Расстояние от города, км
distance_to_ringway Расстояние до кольцевой дороги
full_year_approach Круглогодичный подъезд
direction Направление
water Вода
gas Газ
electricity Электричество
sewage Канализация
heating Отопление
bathhouse Баня
pool Бассейн
fire_alarm Система пожаротушения/пожарная сигнализация
security_alarm Охранная сигнализация
inside_mart Помещение внутри торгового центра/помещение с отдельным входом
environment Окружение
planning Планировка
entries_count Кол-во входных групп
ventilation Вентиляция
electricity_power Электрическая мощность, квт
garage_or_parking Гараж/паркинг
parking_places Паркинг - кол-во машиномест
parking_type Паркинг - вид
parking_ownership Парковка собственная/общая
anchor_operators Якорные операторы
gallery_operators Операторы галереи
heating_type Отопление
train_line Ж/д ветка
ramp Пандус
loading_zones_count Кол-во зон загрузки
loading_equipment Погрузочное оборудование
truck_platform Площадка для маневрирования большегрузного транспорта
from_developer От застройщика //да/нет
complete_business готовый бизнес //да/нет
air_conditioning Кондиционирование // да/нет
description Описание объекта
building_id Id здания
building_type Тип здания //Бизнес-центр/Жилой комплекс
building_title Здание // Название здания
address Адрес
wall_material Материал стен
building_total_area Площадь здания
building_rooms_area Площадь помещений здания
rooms_count Количество кабинетов в здании
flats_count Количество квартир в здании
elevators_count Количество лифтов
elevators_manufacturer Производитель лифтов
ventilation Вентиляция
parking_coefficient Парковочный коэффициент
build_date Дата сдачи ГК
windows Окна
territory_improvement Благоустройство территории
building_description Описание здания
class Класс здания
video_monitoring Система видеонаблюдения
feeding_place Пункт питания
ceiling_type Тип перекрытий
reception Наличие центральной рецепции
access_control Контроль доступа
price_total Цена за весь объект
price_per_meter Цена за квадратны метр
street Улица
toponym Топоним
house_number Номер дома
type_group Супертип (см. Группы типов)
is_foreign Зарубежная недвижимость
is_suburban Загородная недвижимость
is_new Новостройка
url URL-адрес
ipoteka Возможность ипотеки
credit Возможность рассрочки
burden Обременения
relief Рельеф
land_shape Форма участка
land_usage Использование земли
land_usage Использование земли
sublease Субаренда
area_of_each_room Площадь по комнатам
creation_date Дата публикации в формате d.MM.yyyy
creation_datetime Дата и время публикации в формате d.MM.yyyy HH:mm:ss
edit_date Дата редактирования в формате d.MM.yyyy
edit_datetime Дата и время редактирования в формате d.MM.yyyy HH:mm.ss
youtube_url Адрес видео на YouTube
meta_title Заголовок страницы объекта (для SEO-оптимизации)
meta_keywords Ключевые слова для страницы объекта (для SEO-оптимизации)
meta_description Описание для страницы объекта (для SEO-оптимизации)
exclusive_contract_with_owner Эксклюзивный договор с собственником
status Статус объекта (0-активный, 1-успешный, 2-неудачный)
owner Принадлежность (0-наш объект, 1-объект конкурентов, 2-объект собственников, 3-эксклюзивный договор с собственником)
пример ответа в формате XML:
<response>
  <property>
    <id>3094</id>
    <title>Продажа 5-комн. квартиры ул. Покровка д. 42 корп. 6</title>
    <latitude>55.762049</latitude>
    <longitude>37.653954</longitude>
    <zoom>16</zoom>
    <country_id>0</country_id>
    <lock>Нет</lock>
    <city_id>28</city_id>
    <district_id>127</district_id>
    <metro_id>0</metro_id>
    <agent_id>79</agent_id>
    <parameters>
      <parameter name="type" title="Тип недвижимости" value="квартира" />
      <parameter name="deal" title="Тип сделки" value="продажа" />
      <parameter name="city" title="Город" value="Москва" />
      <parameter name="district" title="Район" value="м. Чистые Пруды" />
      <parameter name="area" title="Общая площадь" value="  148.6 м<sup>2</sup>" />
      <parameter name="live_area" title="Жилая площадь" value="  114.0 м<sup>2</sup>" />
      <parameter name="kitchen_area" title="Площадь кухни" value="  11.6 м<sup>2</sup>" />
      <parameter name="rooms" title="Комнат" value="5" />
      <parameter name="floor" title="Этаж" value="1" />
      <parameter name="price_total" title="Цена за весь объект" />
      <parameter name="price_meter" title="Цена за метр" />
      <parameter name="floors_total" title="Этажность" value="5" />
    </parameters>
  </property>
</response>
пример ответа в формате JSON:
{
    "property": {
        "id": 3094,
        "title": "Продажа 5-комн. квартиры Покровка ул. д. 42 корп. 6",
        "latitude": "55.762049",
        "longitude": "37.653954",
        "zoom": 16,
        "country_id": 0,
        "lock": "Нет",
        "city_id": 28,
        "district_id": 127,
        "metro_id": 0,
        "agent_id": 79,
        "parameters": [{
                "name": "type",
                "title": "Тип недвижимости",
                "value": "квартира"
            }, {
                "name": "deal",
                "title": "Тип сделки",
                "value": "продажа"
            }, {
                "name": "city",
                "title": "Город",
                "value": "Москва"
            }, {
                "name": "district",
                "title": "Район",
                "value": "м. Чистые Пруды"
            }, {
                "name": "area",
                "title": "Общая площадь",
                "value": "  148.6 м\u003csup\u003e2\u003c/sup\u003e"
            }, {
                "name": "live_area",
                "title": "Жилая площадь",
                "value": "  114.0 м\u003csup\u003e2\u003c/sup\u003e"
            }, {
                "name": "kitchen_area",
                "title": "Площадь кухни",
                "value": "  11.6 м\u003csup\u003e2\u003c/sup\u003e"
            }, {
                "name": "rooms",
                "title": "Комнат",
                "value": "5"
            }, {
                "name": "floor",
                "title": "Этаж",
                "value": "1"
            }, {
                "name": "price_total",
                "title": "Цена за весь объект",
                "value": null
            }, {
                "name": "price_meter",
                "title": "Цена за метр",
                "value": null
            }, {
                "name": "floors_total",
                "title": "Этажность",
                "value": "5"
            }
        ]Контрагенты
    }
}
http://api.recrm.ru/{формат}/estate/search?key={ключ}
возможные параметры:
query Поиск по тексту. Будут найдены объекты, содержащие переданную в данном параметре строку в названии, описании или названии улицы
agent_id ID агента
status статус объекта (0-активные, 1-успешные, 2-неудачные)
group_id ID группы типов объекта недвижимости (если этот параметр указан, то параметр type_id игнорируется)
type_id ID типа объекта недвижимости
deal тип сделки (1 - продажа, 2 - аренда)
new искать ли только новостройки (1-искать только новостройки; 0 - искать только вторичное жилье; если значение не указано - искать и то и другое)
suburban искать ли только загородную недвижимость (1-искать только загородную; 0 - искать только в черте города; если значение не указано - искать и то и другое)
foreign искать ли только зарубежную недвижимость (1-искать только зарубежную; 0 - искать только местную; если значение не указано - исать и то и другое)
country_id ID страны
city_id ID города
districts ID районов через запятую, без пробелов
metro_ids ID станций метро через запятую, без пробелов
min_area минимальное значение площади
max_area максимальное значение площади
min_ground_area минимальное значение площади земельного участка
max_ground_area максимальное значение площади земельного участка
min_price_total минимальное значение цены за весь объект
max_price_total максимальное значение цены за весь объект
min_price_meter минимальное значение цены за квадратный метр
max_price_meter максимальное значение цены за квадратный метр
floors этажи через запятую, без пробелов
floors_preset шаблон этажа (0-любой этаж,
1-только подвал
2-любой этаж выше подвала (в том числе цокольный)
3-только цокольный
4-любой, кроме цокольного
5-любой этаж выше цокольного
6-только первый
7-любой этаж выше первого
8-только второй
9-любой этаж ниже последнего
10-любой этаж выше первого и ниже последнего
11-только последний
12-только мансардный
13-любой этаж, кроме подвала, цокольного и мансардного
14-подвал или цокольный
15-цокольный или первый)
rooms количество комнат
hot искать только горячие предложения
min_distance_from_city удаленность от города, от (км)
max_distance_from_city удаленность от города, до (км)
has_parking с гаражом/паркингом
building_id Id здания
building_stage стадия строительства (1-готов, 2-строится)
date_from дата создания или редактирования. Если этот параметр указан, то будут выведены только объекты, созданные или отредактированные не ранее указанной даты. Дата должна быть указана в формате d.MM.yyyy либо d.MM.yyyy HH:mm
date_to дата создания или редактирования. Если этот параметр указан, то будут выведены только объекты, созданные или отредактированные не позднее указанной даты. Дата должна быть указана в формате d.MM.yyyy либо d.MM.yyyy HH:mm
search_hidden включить в результаты поиска скрытые объекты (те, которые не должны отображаться на сайте). 1-включить, 0-не включать. значение по умолчанию - 0
complete_business готовый бизнес (1-да, 0-нет)
start начиная с какого объекта вывести результат (счет идет с нуля, при использовании этого параметра обязателен также параметр count). если значение параметра не указано, API вернет только первые 50 объектов
count сколько найденных объектов вывести в результатах поиска. если значение параметра не указано, API вернет только первые 50 объектов
width желаемая ширина фотографий объектов
height желаемая высота фотографий объектов
crop нужно ли обрезать изображение, если его размеры непропорциональны желаемым
1 - обрезать
0 - не обрезать (изображение будет вписано в желаемые размеры)
sort_desc сортировать объекты по убыванию даты создания

пример ответа в формате XML:
<response total_count="2">
  <results>
    <estate>
      <id>3072</id>
      <title>БИЗНЕС ЦЕНТР "ЛИРА" Енисейская, 1</title>
      <picture_path>http://demo.recrm.ru/resources/properties/3072/picture_0001.jpg</picture_path>
      <date>18:43 8.08.2011</date>
      <user_title>Марина Ивановна</user_title>
      <area>43</area>
      <kitchen_area/>
      <live_area/>
      <ground_area/>
      <city_title>Москва</district_title>
      <district_title>м. Свиблово </district_title>
      <price_total>13760</price_total>
      <price_per_meter>320</price_per_meter>
      <hot>false</hot>
      <latitude>37.617761</latitude>
      <longitude>55.755773</longitude>
    </estate>
    <estate>
      <id>3073</id>
      <title>ОФИСНЫЙ ОСОБНЯК, 2 Спасоналивковский переулок, 3</title>
      <picture_path>http://demo.recrm.ru/resources/properties/3073/picture_0001.jpg</picture_path>
      <date>18:43 8.08.2011</date>
      <user_title>Николай Васильевич</user_title>
      <area>1235</area>
      <kitchen_area/>
      <live_area/>
      <ground_area/>
      <city_title>Москва</district_title>
      <price_total>765700</price_total>
      <price_per_meter>620</price_per_meter>
      <hot>true</hot>
      <latitude>37.617761</latitude>
      <longitude>55.755773</longitude>
    </estate>
    ...
  </results>
</response>
пример ответа в формате JSON:
{
    "total_count": 2,
    "results": [{
            "id": 3072,
            "title": "БИЗНЕС ЦЕНТР \"ЛИРА\" Енисейская, 1",
            "picture_path": "http://demo.recrm.ru/resources/properties/3072/picture_0001.jpg",
            "date": "18:43 8.08.2011",
            "user_title": "Марина Ивановна",
            "area": "43",
            "kitchen_area": "",
            "live_area": "",
            "ground_area": "",
            "city_title": "Москва ",
            "lock": "Нет",
            "district_title": "м. Свиблово ",
            "price_total": "13760",
            "price_per_meter": "320",
            "hot": false,
            "latitude": 37.617761,
            "longitude": 55.755773
        }, {
            "id": 3073,
            "title": "ОФИСНЫЙ ОСОБНЯК, 2 Спасоналивковский переулок, 3",
            "picture_path": "http://demo.recrm.ru/resources/properties/3073/picture_0001.jpg",
            "date": "18:43 8.08.2011",
            "user_title": "Николай Васильевич",
            "area": "1235",
            "kitchen_area": "",
            "live_area": "",
            "ground_area": "",
            "city_title": "Москва ",
            "lock": "Заблокирован",
            "district_title": null,
            "price_total": "765700",
            "price_per_meter": "620",
            "hot": true,
            "latitude": 37.617761,
            "longitude": 55.755773
        },
        ...
    ]
}

Создание объекта недвижимости:

Для создания заявки нужно выполнить POST-запрос на url http://api.recrm.ru/{формат}/estate/add
В качестве параметров необходимо передать следующие данные:
Имя поля Описание поля
key ключ API
agent_id ID агента (обязательно)
type_id ID типа недвижимости (обязательно)
is_new Флаг новостройки (по умолчанию: нет)
is_suburban Флаг загородной недвижемости (по умолчанию: нет)
is_foreign Флаг зарубежной недвижимости (по умолчанию: нет)
deal Тип сделки. Поддерживаемые значения: 1 (продажа) и 2 (аренда) (обязательно)
lease_type Тип аренды Поддерживаемые значения: 1 (посуточная аренда), 2 (аренда на несколько месяцев (до года)), 3 (долгосрочная аренда (от года))
title Название объекта (обязательно)
city_id ID города (обязательно)
place Населенный пункт
district_id ID района
street_id ID улицы
house_number Номер дома
metro_id ID станции метро
metro_walk_time Минут пешком до метро (целое число)
metro_transport_time Минут на транспорте до метро (целое число)
distance_to_city Растояние до города, км
route_id ID ближайшего шоссе
distance_to_ringway Расстояние до кольцевой дороги
price_per_meter Цена за метр
price_total Цена за весь объект
currency валюта (1 - Rub, 2 - Euro, 3 - Usd)
area Общая площадь, м2
live_area Жилая площадь, м2
kitchen_area Площадь кухни, м2
ground_area Площадь земельного участка
floor Этаж
floors_total Этажность
rooms Кол-во комнат //для зарубежной недвижимости - кол-во спален// Дополнительные значения: 101-студия, 102 - свободная планировка, 103- доля в квартире, 104 - койко-место.
wall_material_id ID материала стен
finish_id ID типа отделки
ceiling_height Высота потолка
description Описание объекта
air_conditioning ID типа кондиционирования
garage_or_parking Паркинг или гараж (1 - да, 2 - нет)
from_developer Объект от застройщика (1 - да, 0 - нет)
complete_business готовый бизнес, для офисов, торговых помещений и складов (1 - да, 0 - нет)
mortgage Возможность ипотеки (1 - да, 2 - нет)
water ID типа водоснабжения
gas ID типа газоснабжения
electricity ID типа электроснабжения
sewage ID типа канализации
heating Отопление (1 - есть, 2 - нет)
bathhouse Баня (1 - есть, 2 - нет)
pool Бассейн (1 - есть, 2 - нет)
balcony Балкон (1 - есть, 2 - нет, 3 - балкон и лоджия, 4 - два балкона, 5 - две лоджии)
bathroom_type Тип санузла (1 - раздельный, 2 - совмещенный)
bathrooms_count Количество санузлов (целое число)
living_furniture Мебель в жилых комнатах (1 - да, 2 - нет)
kitchen_furniture Мебель на кухне (1 - да, 2 - нет)
electricity_power Выделенная электрическая мощность кВт
heating_type Тип отопления (1 - отсутствует, 2 - газ, 3 - центральное)
parking_places Количество парковочных мест

Обновление объекта недвижимости:

Для создания заявки нужно выполнить POST-запрос на url http://api.recrm.ru/{формат}/estate/update
В качестве параметров необходимо передать следующие данные:
Имя поля Описание поля
key ключ API
id ID объекта (обязательно)
title Название объекта (обязательно)
city_id ID города (обязательно)
district_id ID района
street_id ID улицы
house_number Номер дома
price_per_meter Цена за метр
price_total Цена за весь объект
currency валюта (1 - Rub, 2 - Euro, 3 - Usd)
area Общая площадь, м2
live_area Жилая площадь, м2
floor Этаж
floors_total Этажность
rooms Кол-во комнат //для зарубежной недвижимости - кол-во спален// Дополнительные значения: 101-студия, 102 - свободная планировка, 103- доля в квартире, 104 - койко-место.

Удаление объекта недвижимости:

Для удаления выполните запрос на url http://api.recrm.ru/{формат}/estate/delete?key={ключ}&estate_id={ID объекта}
В качестве параметров необходимо передать следующие данные:

Агенты

получение информации об агенте:

http://api.recrm.ru/{формат}/agent/info?key={ключ}&id={ID агента}

пример ответа в формате XML:
<response>
  <agent>
    <id>81</id>
    <name>Алексей Максимович</name>
    <position>менеджер</position>
    <group_name>Административно-управленческий персонал</group_name>
    <email>apitest@recrm.ru</email>
    <phone>495-111-1111<phone/>
    <mobile_phone>+7 917 1111111<mobile_phone/>
  </agent>
</response>
пример ответа в формате JSON:
{
    "agent":{
        "id":92,
        "name":"Алексей Максимович",
        "position":"менеджер",
        "group_name":"Административно-управленческий персонал",
        "email":"apitest@recrm.ru",
        "phone":"495-111-1111",
        "mobile_phone":"+7 917 1111111"
    }
}

получение списка агентов:

http://api.recrm.ru/{формат}/agent/all?key={ключ}

пример ответа в формате XML:
<response>
  <agents>
    <agent>
      <id>88</id>
      <role>2</role>
      <name>Алексей</name>
      <position>риэлтор</position>
      <group_name>Жилая недвижимость</group_name>
      <email>agent2@recrm.ru</email>
      <phone/>
      <mobile_phone>8-321-333-77-09</mobile_phone>
    </agent>
    <agent>
      <id>89</id>
      <role>2</role>
      <name>Ирина</name>
      <position>диспетчер</position>
      <group_name>Жилая недвижимость</group_name>
      <email>agent3@recrm.ru</email>
      <phone/>
      <mobile_phone>8-830-175-84-11</mobile_phone>
    </agent>
    <agent>
      <id>90</id>
      <role>3</role>
      <name>Владимир</name>
      <group_name>Vladof</group_name>
      <email>agent4@recrm.ru</email>
      <mobile_phone>8-428-873-28-06</mobile_phone>
    </agent>
  </agents>
</response>
пример ответа в формате JSON:
{
  "agents":[{
    "id":88,
    "email":"agent2@recrm.ru",
    "group_name":"Жилая недвижимость",
    "mobile_phone":"8-321-333-77-09",
    "name":"Алексей",
    "phone":"",
    "position":"риэлтор",
    "role":2
  },{
    "id":89,
    "email":"agent3@recrm.ru",
    "group_name":"Жилая недвижимость",
    "mobile_phone":"8-830-175-84-11",
    "name":"Ирина",
    "phone":"",
    "position":"диспетчер",
    "role":2
  },{
    "id":90,
    "email":"agent4@recrm.ru",
    "group_name":"Vladof",
    "mobile_phone":"8-428-873-28-06",
    "name":"Владимир",
    "phone":null,
    "position":null,
    "role":3
  }]
}

Изображения

получение главной фотографии объекта недвижимости:

http://api.recrm.ru/{формат}/picture/EstateCoverPhoto?key={ключ}&estate_id={ID объекта}&width=640&height=480&crop=1&watermark=0

Подробное описание параметров
Имя поля Описание поля
estate_id ID объекта, фотографию которого необходимо получить
width желаемая ширина изображения
height желаемая высота изображения
crop нужно ли обрезать изображение, если его размеры непропорциональны желаемым
1 - обрезать
0 - не обрезать (изображение будет вписано в желаемые размеры)
watermark нужно ли накладывать водный знак на изображение
1 - да (для этого водный знак должен быть указан в настройках CRM)
0 - нет
пример ответа в формате XML:
<response>
  <pictures>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"/>
  </pictures>
</response>
пример ответа в формате JSON:
{
  "pictures":[
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"}
  ]
}


получение всех фотографий объекта недвижимости

http://api.recrm.ru/{формат}/picture/EstatePhoto?key={ключ}&estate_id={ID объекта}&width=640&height=480&crop=1&watermark=0

получение всех планировок объекта недвижимости

http://api.recrm.ru/{формат}/picture/EstateLayout?key={ключ}&estate_id={ID объекта}&width=640&height=480&crop=1&watermark=0

Подробное описание параметров (параметры одинаковы для фотографий и планировок)
Имя поля Описание поля
estate_id ID объекта, фотографию которого необходимо получить
width желаемая ширина изображения
height желаемая высота изображения
crop нужно ли обрезать изображение, если его размеры непропорциональны желаемым
1 - обрезать
0 - не обрезать (изображение будет вписано в желаемые размеры)
watermark нужно ли накладывать водный знак на изображение
1 - да (для этого водный знак должен быть указан в настройках CRM)
0 - нет
пример ответа в формате XML (структура ответа одинакова для фотографий и планировок):
<response>
  <pictures>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"/>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0002.jpg?E586F793E513644F62EF8DE27101F31B"/>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0003.jpg?8DE36446F793E58E2EFF62751101F31B"/>
  </pictures>
</response>
пример ответа в формате JSON (структура ответа одинакова для фотографий и планировок):
{
  "pictures":[
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"},
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?E586F793E513644F62EF8DE27101F31B"},
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?8DE36446F793E58E2EFF62751101F31B"}
  ]
}


Добавление фотографии объекта недвижимости:

Для добавления фотографии нужно выполнить POST-запрос на url http://api.recrm.ru/{формат}/picture/addestatephotofromurl
В качестве параметров необходимо передать следующие данные:
Имя поля Описание поля
key ключ API
estate_id ID объекта (обязательно)
url url изображения (обязательно)

получение всех фотографий здания

http://api.recrm.ru/{формат}/picture/BuildingPhoto?key={ключ}&building_id={ID здания}&width=640&height=480&crop=1&watermark=0

Подробное описание параметров
Имя поля Описание поля
building_id ID здания, фотографии которого необходимо получить
width желаемая ширина изображения
height желаемая высота изображения
crop нужно ли обрезать изображение, если его размеры непропорциональны желаемым
1 - обрезать
0 - не обрезать (изображение будет вписано в желаемые размеры)
watermark нужно ли накладывать водный знак на изображение
1 - да (для этого водный знак должен быть указан в настройках CRM)
0 - нет
пример ответа в формате XML
<response>
  <pictures>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"/>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0002.jpg?E586F793E513644F62EF8DE27101F31B"/>
    <picture url="http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0003.jpg?8DE36446F793E58E2EFF62751101F31B"/>
  </pictures>
</response>
пример ответа в формате JSON
{
  "pictures":[
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?6F793E58E2EF8DE27513644F6101F31B"},
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?E586F793E513644F62EF8DE27101F31B"},
    {"url":"http://rg.local/Static/SIMG/640_480_A_MC_jpg_W/resources/properties/3149/picture_0001.jpg?8DE36446F793E58E2EFF62751101F31B"}
  ]
}


получение фотографии агента:

http://api.recrm.ru/{формат}/picture/AgentPhoto?key={ключ}&agent_id={ID объекта}&width=200&height=400&crop=0

Подробное описание параметров
Имя поля Описание поля
agent_id ID агента, фотографию которого необходимо получить
width желаемая ширина изображения
height желаемая высота изображения
crop нужно ли обрезать изображение, если его размеры непропорциональны желаемым
1 - обрезать
0 - не обрезать (изображение будет вписано в желаемые размеры)
пример ответа в формате XML:
      <response>
        <pictures>
          <picture url="http://rg.local/Static/TIMG/200_300_A_MC_jpg_W/resources/avatars/group_0006/user_0069/do_next_0001.jpg?6D06E76CAEDE7EEAC339FDA39E6059CA"/>
        </pictures>
      </response>
      
пример ответа в формате JSON:
      {
        "pictures":[
          {"url":"http://rg.local/Static/TIMG/200_300_A_MC_jpg_W/resources/avatars/group_0006/user_0069/do_next_0001.jpg?6D06E76CAEDE7EEAC339FDA39E6059CA"}
        ]
      }
      

Контрагенты

получение списка всех контрагентов:

http://api.recrm.ru/{формат}/contragent/getall?key={ключ}
Список возможных значений полей контрагента
Имя поля Описание поля
id ID контрагента
agent_id ID ответственного агента
type Тип контрагента (1-клиент, 2-собственник, 3-конкурент)
name Имя контрагента в именительном падеже (для физ. лиц)
name_rod Имя контрагента в родительном падеже (для физ. лиц)
organization Название организации (для юр.лиц)
director_name Имя директора в именительном падеже (для юр. лиц)
director_name_rod Имя директора в родительном падеже (для юр. лиц)
email Email
mobile_phone Мобильный телефон
city_phone Городской телефон
other_phone Другой телефон
notes Заметки
creation_datetime Дата и время создания контрагента в формате д.мм.гггг ЧЧ:мм
update_datetime Дата и время последнего обновления информации о контрагенте в формате д.мм.гггг ЧЧ:мм
пример ответа в формате XML:
      <response>
        <contragents>
          <contragents>
            <id>1</id>
            <agent_id>10</agent_id>
            <type>1</type>
            <name>Иванов Иван Иванович</name>
            <name_rod>Иванова Ивана Ивановича</name_rod>
            <email>ivanov@example.com</email>
            <mobile_phone>89111111111</mobile_phone>
            <city_phone/>
            <other_phone/>
            <notes>заметки о клиенте</notes>
            <creation_datetime>3.03.2014 15:01</creation_datetime>
            <update_datetime>3.05.2014 18:01</update_datetime>
          </contragents>
        </contragents>
      </response>
      
пример ответа в формате JSON:
  {
    "contragents":[{
        "agent_id":0,
        "city_phone":null,
        "creation_datetime":null,
        "update_datetime":null,
        "director_name":null,
        "director_name_rod":null,
        "email":"ivanov@example.com",
        "id":1,
        "mobile_phone":"89111111111",
        "name":"Иванов Иван Иванович",
        "name_rod":"Иванова Ивана Ивановича",
        "notes":"заметки о клиенте",
        "organization":null,
        "other_phone":null,
        "type":1
      },...
	]}
Необходимо выполнить POST-запрос на адрес: http://api.recrm.ru/{формат}/contragent/search?key={ключ}

Список возможных параметров поиска
Имя поля Описание поля
name наименование контрагента - имя (для физ.лица) или наименование (для юр.лица)
is_legal является ли искомый контрагент юридическим лицом. true/false
mobile_phone мобильный телефон. можно указать одно и то же значение для мобильного, городского и других телефонов, т.к. поиск по телефонам выполняется с помощью логической операции ИЛИ
city_phone городской телефон. можно указать одно и то же значение для мобильного, городского и других телефонов, т.к. поиск по телефонам выполняется с помощью логической операции ИЛИ
other_phone другой телефон. можно указать одно и то же значение для мобильного, городского и других телефонов, т.к. поиск по телефонам выполняется с помощью логической операции ИЛИ
email адрес email

Поиск вернет ID одного наиболее подходящего под параметры поиска контрагента или -1, если ничего не будет найдено

пример ответа в формате XML:
      <response>
        <contragent_id>125</id>
      </response>
      
пример ответа в формате JSON:
      {
        "contragent_id": 125
      }
      

получение информации о контрагенте:

http://api.recrm.ru/{формат}/contragent/info?key={ключ}&id={ID контрагента}

Список возможных значений полей контрагента
Имя поля Описание поля
id ID контрагента
agent_id ID ответственного агента
type Тип контрагента (1-клиент, 2-собственник, 3-конкурент)
name Имя контрагента в именительном падеже (для физ. лиц)
name_rod Имя контрагента в родительном падеже (для физ. лиц)
organization Название организации (для юр.лиц)
director_name Имя директора в именительном падеже (для юр. лиц)
director_name_rod Имя директора в родительном падеже (для юр. лиц)
email Email
mobile_phone Мобильный телефон
city_phone Городской телефон
other_phone Другой телефон
notes Заметки
creation_datetime Дата и время создания контрагента в формате д.мм.гггг ЧЧ:мм
update_datetime Дата и время последнего обновления информации о контрагенте в формате д.мм.гггг ЧЧ:мм
пример ответа в формате XML:
      <response>
        <contragent>
          <id>1</id>
          <agent_id>10</agent_id>
          <type>1</type>
          <name>Иванов Иван Иванович</name>
          <name_rod>Иванова Ивана Ивановича</name_rod>
          <email>ivanov@example.com</email>
          <mobile_phone>89111111111</mobile_phone>
          <city_phone/>
          <other_phone/>
          <notes>заметки о клиенте</notes>
          <creation_datetime>3.03.2014 15:01</creation_datetime>
          <update_datetime>3.05.2014 18:01</update_datetime>
        </contragent>
      </response>
      
пример ответа в формате JSON:
      {
        "contragent": {
          "id":1,
          "agent_id":10,
          "type":1,
          "name":"Иванов Иван Иванович",
          "name_rod":"Иванова Ивана Ивановича",
          "email":"ivanov@example.com",
          "mobile_phone":"89111111111",
          "notes":"заметки о клиенте",
          "creation_datetime":"3.03.2014 15:01"
          "update_datetime":"3.05.2014 18:01"
        }
      }
      

Заявки

получение подробной информации по заявке:

http://api.recrm.ru/{формат}/request/info?key={ключ}&id={ID заявки}
Список возможных значений полей заявки
Имя поля Описание поля
id ID заявки
title Название заявки
description Описание заявки
agent_id ID ответственного агента
contragent_id ID клиента
country_id ID страны
city_id ID города
district_ids Массив ID районов
metro_ids Массив ID станций метро
Список возможных значений в разделе parameters ответа
Имя поля Описание поля
type Название типа недвижимости
deal Тип сделки словами
country Название страны
city Название города
district Названия районов (через запятую)
metro Названия станций метро (через запятую)
new Является ли заявка заявкой на поиск новостроек
suburban Является ли заявка заявкой на поиск загородной недвижимости
foreign Является ли заявка заявкой на поиск зарубежной недвижимости
min_area Минимальная площадь
max_area Максимальная площадь
min_ground_area Минимальная площадь земли
max_ground_area Максимальная площадь земли
min_price_meter Минимальная цена за метр
max_price_meter Максимальная цена за метр
min_price_total Минимальная цена за весь объект
max_price_total Максимальная цена за весь объект
floor Этаж
rooms Количество комнат
min_distance Минимальное расстояние от города
max_distance Максимальное расстояние от города
пример ответа в формате XML:
      <response>
        <request>
          <id>2111</id>
          <title>Тестовая заявка</title>
          <description>2111</description>
          <agent_id>69</agent_id>
          <contragent_id>460</contragent_id>
          <country_id>44</country_id>
          <city_id>199</city_id>
          <district_ids>35</district_ids>
          <district_ids>33</district_ids>
          <parameters>
            <parameter name="deal" title="Тип сделки" value="продажа"/>
            <parameter name="city" title="Город" value="Москва"/>
            <parameter name="district" title="Район" value="Восточное измайлово, Арбат"/>
            <parameter name="new" title="Новостройка" value="нет"/>
            <parameter name="suburban" title="За городом" value="нет"/>
            <parameter name="foreign" title="Зарубежная недвижимость" value="нет"/>
            <parameter name="min_area" title="Площадь, от" value="50" unit="м<sup>2</sup>"/>
            <parameter name="max_area" title="Площадь, до" value="60" unit=" м<sup>2</sup>"/>
            <parameter name="min_price_total" title="Общая цена, от" value="1000" unit="руб."/>
            <parameter name="max_price_total" title="Общая цена, до" value="2000" unit="руб."/>
            <parameter name="type_group" title="Супертип" value="6"/>
          </parameters>
        </request>
      </response>
      
пример ответа в формате JSON:
      {
        "request":{
          "id":2111,
          "title":"Тестовая заявка"
          "agent_id":69,
          "city_id":199,
          "contragent_id":460,
          "country_id":44,
          "description":"2111",
          "district_ids":[35,33],
          "metro_ids":null,
          "parameters":[
            {"name":"deal","title":"Тип сделки","unit":null,"value":"продажа"},
            {"name":"city","title":"Город","unit":null,"value":"Москва"},
            {"name":"district","title":"Район","unit":null,"value":"Восточное измайлово, Арбат"},
            {"name":"new","title":"Новостройка","unit":null,"value":"нет"},
            {"name":"suburban","title":"За городом","unit":null,"value":"нет"},
            {"name":"foreign","title":"Зарубежная недвижимость","unit":null,"value":"нет"},
            {"name":"min_area","title":"Площадь, от","unit":"м<sup>2<\/sup>","value":"50"},
            {"name":"max_area","title":"Площадь, до","unit":" м<sup>2<\/sup>","value":"60"},
            {"name":"min_price_total","title":"Общая цена, от","unit":"руб.","value":"1000"},
            {"name":"max_price_total","title":"Общая цена, до","unit":"руб.","value":"2000"},
            {"name":"type_group","title":"Супертип","unit":null,"value":"6"}
          ]
        }
      }
      
http://api.recrm.ru/{формат}/request/search?key={ключ}
Параметры поиска - такие же, как при поиске объектов недвижимости.
Важно: при выполнении данного запроса необходимо обязательно указать один из параметров: group_id или type_id

пример ответа в формате XML:
        <response total_count="2">
          <results>
            <request>
              <id>28</id>
              <agent_id>29</agent_id>
              <deal>2</deal>
              <title>Тестовая заявка</title>
              <type_group>6</type_group>
              <type_id>0</type_id>
              <min_area>0</min_area>
              <max_area>0</max_area>
            </request>
            <request>
              <id>431</id>
              <agent_id>1</agent_id>
              <deal>1</deal>
              <title>Заявка для ООО Тестер</title>
              <type_group>6</type_group>
              <type_id>1</type_id>
              <min_area>100</min_area>
              <max_area>400</max_area>
            </request>
          </results>
        </response>
      
пример ответа в формате JSON:
      {
        "results":[
          {
            "agent_id":29,
            "deal":2,
            "floors":null,
            "id":28,
            "max_area":0,
            "min_area":0,
            "title":"Тестовая заявка",
            "type_group":6,
            "type_id":0
          },
          {
            "agent_id":1,
            "deal":1,
            "floors":null,
            "id":431,
            "max_area":400,
            "min_area":100,
            "title":"Заявка для ООО Тестер",
            "type_group":6,
            "type_id":1
          }
        ],
        "total_count":2
      }

      

Создание заявки:

Для создания заявки нужно выполнить POST-запрос на url http://api.recrm.ru/{формат}/request/submit
В качестве параметров необходимо передать следующие данные:
Имя поля Описание поля
key ключ API
name имя клиента (обязательно)
phone телефон клиента (обязательно)
comment комментарий к заявке

Также в качестве параметров необходимо передать данные поискового запроса объектов недвижимости (список возможных параметров можно посмотреть в документации: http://api.recrm.ru/doc/index.html#estate_search). Если параметры поиска не будут переданы, или же будет передано недостаточное количество параметров для создания заявки, то заявка не будет создана.

Важно: обязательно должны быть указаны такие параметры, как group_id, type_id, deal.

В результате выполения запроса заявка должна появиться в CRM, в очереди на модерацию. А в разделе CRM "Заявки" появится ссылка "С сайта", видимая для администратора. При переходе по этой ссылке можно будет увидеть очередь на модерацию заявок. Если одобрить заявку из списка, то она появится в общем списке заявок (а также будет создан контрагент).

Пример запроса для создания заявки на аренду офиса:

POST http://api.recrm.ru/xml/request/submit?key={API-ключ}&name=Иванов Иван&phone=+79171111111&group_id=6&type_id=1&deal=2

После выполнения такого запроса заявка появится в очереди на модерацию в CRM: http://{ваш-аккаунт}.recrm.ru/requests-moderate/

Настройки и системная информация

Получение системной информации об агенте:

http://api.recrm.ru/{формат}/settings/agent?key={ключ}&id={ID агента}
Список возможных параметров
Имя поля Описание поля
id ID агента
ip_telephony_enabled Включена ли у агента IP-телефония
ip_telephony_login Логин для IP-телефонии у данного агента
ip_telephony_internal_number Внутренний номер IP-телефонии


пример ответа в формате XML:
        <response>
          <agent_settings>
            <id>87</id>
            <ip_telephony_enabled>false</ip_telephony_enabled>
            <ip_telephony_login>User_05</ip_telephony_login>
            <ip_telephony_internal_number>123</ip_telephony_internal_number>
          </agent_settings>
        </response>
      
пример ответа в формате JSON:
      {
        "agent_settings":
        {
          "Id":87,
          "IpTelephonyEnabled":false,
          "IpTelephonyInternalNumber":"111",
          "IpTelephonyLogin":"User_05"
        }
      }