Документация по API

Начало работы

Мы поддерживаем два варианта взаимодействия: запросы в формате JSON и протокол SOAP. Все запросы выполняются через защищенное соединение SSL и должны быть авторизованы.

Для отладки интеграции доступен тестовый сервер.
Перед работой на тестовом сервере необходимо зарегистрировать аккаунт. 

// Адрес для отправки запросов в формате JSON
https://zipal.ru/ws/json

WSDL описание для работы по протоколу SOAP доступно по адресу

// Описание WSDL
https://zipal.ru/ws/api.wsdl

Авторизация

Возможны 3 способа авторизации запросов:

  • По протоколу OAuth 2.0
  • Авторизация по протоколу SOAP
  • Передача логина и пароля в теле JSON запроса

JSON

Передача логина и пароля в теле JSON запроса

Пример отправки запроса с логином и паролем в теле запроса.

Запрос

// Логин и пароль передаются в запросе
{
  "login": "user_login",
  "password": "user_password",
  "request": {
    // Тело запроса
  }
}

user_login - логин пользователя на Zipal.ru

user_password - пароль пользователя на Zipal.ru

SOAP (WSS)

Авторизация по протоколу SOAP

Пример отправки запроса с SOAP хедером авторизации пользователя.

Запрос

<soapenv:Envelope xmlns:api="http://assis.ru/ws/api" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
        <wsse:UsernameToken>
            <wsse:Username>user_login</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">user_password</wsse:Password>
         </wsse:UsernameToken>         
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:GetCitiesRequest region="50" str="нов"/>
   </soapenv:Body>
</soapenv:Envelope>

user_login - логин пользователя на Zipal.ru

user_password - пароль пользователя на Zipal.ru

Передача адреса

Мы поддерживаем 4 способа передачи адреса:

  1. По коду КЛАДР (наиболее точный способ)
  2. В виде простой строки (наименее точный способ)
  3. В виде координат
  4. В виде адресной строки разбитой на элементы в соответствии с региональным делением (второй по точности способ)

Номер дома передается отдельным полем dom. В виде строки включающей корпус, строение и т.д.

Код КЛАДР

Передача адреса в виде кода КЛАДР KLADRStreetType2

Наиболее точный способ передачи адреса.

// Адрес в виде кода КЛАДР
{
  "address": {
    "street": {
      "type": "KLADRStreetType2",
      "code": "72000001000049300"
    },
    "dom": "3А"
  }
}

Строкой

Передача адреса в виде простой строки.

Наименее точный способ передачи адреса.

// Адрес в виде простой строки
{
  "address": {
    "street": {
      "type": "SimpleStreetType",
      "name": "Московская область, г. Долгопрудный, ул. Московская",
      "allowWeak": true // Поиск неточного соответствия
    },
    "dom": "3А"
  }
}

По координатам

// Адрес в виде координат
{
  "address": {
    "coordinates": {
      "lat": 55.962318,
      "lon": 37.525091
    }
  }
}

Набор строк

Передача адреса в виде строки разбитой на логические части StringStreetType

type - тип географического объекта. Например: деревня, улица, город.

Второй по точности способ, после передачи по коду КЛАДР.

// Адрес в виде набора частей
{
  "address": {
    "street": {
      "type": "StringStreetType",
      "region": {
        "value": "Московская область"
      },
      "part": [
        {
          "type": "г.",
          "value": "Долгопрудный"
        },
        {
          "type": "ул.",
          "value": "Московская"
        }
      ]
    },
    "dom": "3А"
  }
}

Справочники

Чаще всего мы можем определить нужные значения полей автоматически с достаточной точностью. Тем не менее ниже приводим список справочников, которыми вы можете воспользоваться для указания точных значений.

КЛАДР

Адреса можно передавать в соответствии с официальным государственным классификатором адресов Классификатор адресов России (КЛАДР). В этом случае в качестве адреса объекта необходимо передавать соответствующие коды КЛАДР.

Запроc

// Получение кода КЛАДР для адреса "город Красноярск, проспект Мира"
https://zipal.ru/kladr/address?term=город Красноярск, проспект Мира

Ответ

[
  {
    "code":"24000001000044300",
    "label":"Мира пр-кт, Красноярск г, Красноярский край, Россия",
    "lat":56.0116,
    "lon":92.8637
  }
]

Районы

Определяем автоматически

https://zipal.ru/import/districts.xml

Микрорайоны

Определяем автоматически

https://zipal.ru/import/sub_districts.xml

Шоссе

Определяем автоматически

https://zipal.ru/import/highways.xml

Метро

Определяем автоматически

https://zipal.ru/import/metros.xml

Новостройки

https://zipal.ru/import/buildings.xml

Создание объекта

При работе по протоколу SOAP воспользуйтесь WSDL описанием. Ниже будут описаны основные методы и типы данных в формате JSON.

Продажа квартиры

В том числе продажа новостройки, долевого, комнаты.

// Создание объявления по продаже квартиры
{
  "method": "CreateProperty",
  "request": {
    "requestType": "FlatSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "metros": { // Не обязательно, определяется автоматически
        "metro": [
          {
            "id": 100, // идентификатор или
            "name": "Проспект Вернадского", // название станции
            "distanceToMetro": 10,
            "distanceType": "TRANSPORT",
          }
        ]
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
      "subagentAvatarUrl": "http://test.local",
      "privatization": true,
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "rightOwnership": false, // Есть право собственности
      "greedRedevelopment": false, // Согласована перепланировка
      "apartments": true, // Апартаменты
      "type[FlatType]": "STUDIO",
      "flatHouseType[FlatHouseType]": "SPECIAL",
      "roomsCount": 5,
      "roomsCountTotal": 5,
      "separatedRoomsCount": 5,
      "floorNumber": 10,
      "floorsNumber": 15,
      "material": "MONOLITH",
      "credit": true, // Рассрочка
      "mortgage": true, // Ипотека
      // Дополнительные (не обязательные) поля блока specific
      "offerType": "FLAT",
      "usefulSquare": 120,
      "kitchenSquare": 15,
      "ceilingHeight": 300, // Сантиметров
      "developer": "Монолит",
      "buildingName": "ЖК Новостройка", //Название ЖК (обязательно для новостроек)
      "documentationUrl": "https://zipal.ru", //Ссылка на проектную документацию (обязательно для новостроек)
      "reassignment": true, // переуступка
      "firstSale": true, // первичная продажа вторички
      "series": "П44Т", // Серия дома
      "flatStatus": "ALTERNATIVE",
      "plumbing": "CENTRAL",
      "renovation": "NONE",
      "toilet": "THREE",
      "balcony": "ONE",
      "loggia": "ONE",
      "elevator": "ONE",
      "serviceElevator": "ONE",
      "heating": "LIQUID",
      "windowView": "STREET", //Вид из окон (STREET, YARD, BOTH)
      "newFlat": "READY",
      "readyDate": {
        "quarter": "I",
        "year": 2014
      },
      "developer": "Developer", //Застройщик"
      "developerUrl": "http://example.com", //Адрес сайта застройщика"
      "developerPhone":"+799988887777",
      "developerLogoUrl":"http://example.com/logo"
      "investorType": "INDIVIDUAL", //Дольщик
      "investorLastName": "Петров", // Фамилия дольщика(если дольщик физ. лицо)
      "investorFirstName": "Петр", // Имя дольщика (если дольщик физ. лицо)
      "investorPatronymic": "Петрович", // Отчество дольщика (если дольщик физ. лицо)
      "number": 123,
      "chambers": "12+14+13+(10+11)",
      "door":"METAL",         // допустимые значения:  WOOD, METAL, METAL_WOOD, WOOD_METAL
      "flatFloor":"LINOLEUM",         // допустимые значения:  LINOLEUM, LAMINATE, CARPETING, PARQUET, BATTEN, NO
      "windowMaterial":"PLASTIC",    // допустимые значения:  WOOD, PLASTIC
      "apartmentPosition":"CORNER", // допустимые значения:  CORNER, NOT_
      "linkExtractEgrn": "https://example.com", // Ссылка на выписку ЕГРН
      "feature": [
        // Допустимые значения
        "INTERNET", 
        "TELEPHONE", 
        "TV", 
        "INVALIDS",
        "CONCIERGE", 
        "GUARDS", 
        "RUBBISH_CHUTE", 
        "GAS", 
        "FENCING",
        "INTERCOM",
        "WATER_METER"
      ]
    }
  }
}

Продажа дома

В том числе продажа коттеджа, дачи, таунхауса

// Создание объявления по продаже дома
{
  "method": "CreateProperty",
  "request": {
    "requestType": "HouseSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "9f63e36c-8f42-42f5",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "landSquare": 10, // Соток
      "houseType": "TOWNHOUSE",
      "landCadastralNumber": "0987654321", // Кадастровый номер для земельного участка
      "distance": 23, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "YES",
      "gas": "BORDER",
      "plumbing": "NO",
      "sewerage": "CENTRAL",
      "relief": "HILLS",
      "furniture": "PART",
      "renovation": "AUTHOR",
      "material": "BRICK",
      "heating": "LOCAL",
      "shape": "REGULAR",
      "purpose": "INDUSTRIAL",
      "credit": false,
      "mortgage": true,
      // Дополнительные (не обязательные) поля блока specific
      "landUsageType": "GARDEN",
      "communityName": "Зеленые горки",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции (в минутах в пути).
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 200, // До леса (метров).
      "waterDistance": 500, // До водоема (метров).
      "floorsNumber": 3,
      "toilet": "JOINED",
      "flatStatus": "ALTERNATIVE",
      "roomsCount": 10,
      "year": 2010, // Год постройки
      "feature": [
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "TELEPHONE", 
        "INTERNET", 
        "TV", 
        "GARAGE", 
        "SAUNA", 
        "POOL", 
        "BOILER", 
        "MANSARD", 
        "RESIDENCE", 
        "FOREST", 
        "WATER"
      ]
    }
  }
}

Продажа земли

// Создание объявления по продаже земли
{
  "method": "CreateProperty",
  "request": {
    "requestType": "LandSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150, // Соток
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "purpose": "FORESTS",
      "distance": 100, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "POSSIBLE",
      "gas": "NO",
      "plumbing": "HOLE",
      "sewerage": "CESSPOOL",
      "relief": "SLOPE",
      "shape": "REGULAR",
      // Дополнительные (не обязательные) поля блока specific
      "flatStatus": "ALTERNATIVE",
      "landUsageType": "SNT", // Обязательно, если purpose: SETTLEMENTS или AGRICULTURAL
      "communityName": "Зеленые горки",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции (в минутах в пути).
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 200, // До леса (метров).
      "waterDistance": 500, // До водоема (метров).
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "FOREST", 
        "WATER"
      ],
    }
  }
}

Продажа офиса

// Создание объявления по продаже офиса
{
  "method": "CreateProperty",
  "request": {
    "requestType": "OfficeSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parts": [{ // продажа по частям
        "square": 20.0, // площадь части
        "price": 100 // цена части
      }],
      "buildingClass": "C",
      "layout": "FREE",
      "buildingType": "OFFICE_WAREHOUSE",
      "vatType": "VAT_INCLUDED", // НДС включен
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "entryType": "SEPARATE_FROM_YARD",
      "feature": [
        // Допустимые значения
        "REPAIR_BY_OWNER", 
        "ANY_INET_PROVIDER",
        "FIRST_LINE", 
        "RESTAURANT", 
        "FITNESS", 
        "BANK", 
        "ATM", 
        "SUPERMARKET", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL", 
        "ELEVATOR", 
        "CLIENTS_ACCESS", 
        "CONDITIONER", 
        "HEATING", 
        "SEPARATE_ENTRY"
      ]
    }
  }
}

Продажа коммерческого помещения

// Создание объявления по продаже коммерческого помещения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "BusinessSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "buildingName": "Светлый"                  // Название ЖК
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parts": [{ // продажа по частям
        "square": 20.0, // площадь части
        "price": 100 // цена части
      }],
      "buildingType": "OFFICE_WAREHOUSE",
      "standaloneBuilding": true,
      "vatType": "VAT_INCLUDED", // НДС включен
      // Дополнительные (не обязательные) поля блока specific
      "readyBusiness": true, // Готовый бизнес
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "WASH",
      "businessUsageTypes": ["GAS_STATION", "WASH"],
      "hallSquare": 100,
      "entryType": "SEPARATE_FROM_YARD",
      "byPart": true, // Можно частями
      "minSquare": 20 // Минимальная площадь
      "feature": [
        // Допустимые значения
        "REPAIR_BY_OWNER", 
        "ANY_INET_PROVIDER", 
        "FIRST_LINE", 
        "RESTAURANT", 
        "FITNESS", 
        "BANK", 
        "ATM", 
        "SUPERMARKET", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL", 
        "EQUIPMENT", 
        "SEPARATE_ENTRY"
      ]
    }
  }
}

Продажа склада

Продажа складского помещения

// Создание объявления по продаже складского помещения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "WarehouseSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "sublease": true,
      "vatType": "VAT_INCLUDED", // НДС включен
      "warehouseType": "MIXED",
      "floorsNumber": 5,
      "basementFloor": true,
      "groundFloor": false,
      "floorNumber": 3,
      // Дополнительные (не обязательные) поля блока specific
      "conditioning": "CLIMATE_CONTROL",
      "storageType": "RACK",
      "floorPressure": 100, // Нагрузка на пол (тонн)
      "columnSpace": 10, // Шаг колонн (м)
      "power": 1000, // Подведенная мощьность (кв)
      "floor": "TILE", // Покрытие полов
      "unloading": "CAR_ENTRY",
      "gate": "RAMPANT",
      "highwayAccess": "NONE",
      "ceilingHeight": 500, // Высота потолков (см)
      "year": 2014,
      "entryType": "SEPARATE_FROM_YARD",
      "structureType": "DETACHED",
      "byPart": true, // Можно частями
      "minSquare": 20 // Минимальная площадь
      "feature": [
        // Допустимые значения
        "CRANE", 
        "CUSTOMS", 
        "RAILWAY", 
        "TRUCK_PARKING", 
        "PORT", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL"
      ]
    }
  }
}

Продажа коммерческой земли

Продажа земли коммерческого назначения

// Создание объявления по продаже земли коммерческого назначения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "CommLandSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150, // Соток
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "purpose": "FORESTS",
      "distance": 100, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "POSSIBLE",
      "gas": "NO",
      "plumbing": "HOLE",
      "sewerage": "CESSPOOL",
      "relief": "SLOPE",
      "shape": "REGULAR",
      "vatType": "VAT_INCLUDED", // НДС включен
      // Дополнительные (не обязательные) поля блока specific
      "landUsageType": "SNT", // Обязательно, если purpose: SETTLEMENTS или AGRICULTURAL
      "communityName": "Зеленые горки",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции (в минутах в пути).
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 200, // До леса (метров).
      "waterDistance": 500, // До водоема (метров).
      "byPart": true, // Можно частями
      "minSquare": 20 // Минимальная площадь
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "FOREST", 
        "WATER"
      ],
    }
  }
}

Продажа гаража

Продажа гаража

// Создание объявления по продаже гаража
{
  "method": "CreateProperty",
  "request": {
    "requestType": "GarageSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "garageType": "STANDALONE",
      "stories": 1,
      // Дополнительные (не обязательные) поля блока specific
      "assignmentOfLeaseRights": true,
      "garageMaterial": "BRICK",
      "ceilingHeight": 500, // Высота потолков (см)
      "year": 2014,
      "totalParkingLots": 2,
      "feature": [
        // Допустимые значения
        "HEATING"
      ]
    }
  }
}

Продажа машиноместа

Продажа машиноместа

// Создание объявления по продаже машиноместа
{
  "method": "CreateProperty",
  "request": {
    "requestType": "ParkingLotSellRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parkingLotType": "OPEN",
      // Дополнительные (не обязательные) поля блока specific
      "assignmentOfLeaseRights": true,
      "feature": [
        // Допустимые значения
        "HEATING",
        "GSK"
      ]
    }
  }
}

Аренда квартиры

В том числе аренда комнаты

// Создание объявления по аренде квартиры
{
  "method": "CreateProperty",
  "request": {
    "requestType": "FlatRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000,
      "currency": "RUR",
      "square": 150,
      "priceType": "MONTH",
      "period": "SEASON",
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "apartments": true, // Апартаменты
      "type[FlatType]": "INDIVIDUAL",
      "flatHouseType[FlatHouseType]": "BREZHNEVKA",
      "roomsCount": 2,
      "roomsCountTotal": 2,
      "separatedRoomsCount": 2,
      "floorNumber": 5,
      "floorsNumber": 8,
      "material": "PANEL",
      // Дополнительные (не обязательные) поля блока specific
      "offerType": "FLAT",
      "usefulSquare": 120,
      "kitchenSquare": 15,
      "ceilingHeight": 300, // Сантиметров
      "buildingName": "ЖК Новостройка", //Название ЖК
      "renovation": "NONE",
      "toilet": "JOINED",
      "balcony": "ONE",
      "loggia": "ONE",
      "elevator": "ONE",
      "serviceElevator": "ONE",
      "series": "П44Т",
      "heating": "LIQUID",
      "maxPeople": 4,
      "utilities": 5000,
      "chambers": "12+14"
      "utilityMeters": true,  // Оплата по счетчикам производится арендатором (true - оплачивается арендатором. false - оплачивается собственником).
      "otherUtilities": true, // Другие ЖКУ (отопление, капремонт, вывоз мусора и другие услуги) (true - оплачивается арендатором. false - оплачивается собственником).
      "otherUtilitiesPayment": "10000", // Плата за другие ЖКУ (отопление, капремонт, вывоз мусора и другие услуги) в месяц. Обязательно если передается значение "otherUtilities": true.
      "feature": [
        "INTERNET", 
        "TELEPHONE", 
        "TV", 
        "INVALIDS", 
        "WASHING_MACHINE", 
        "FURNITURE", 
        "FRIDGE", 
        "WIRELESS_INTERNET", 
        "WITH_PETS", 
        "WITH_CHILDREN",
        "CONCIERGE", 
        "GUARDS", 
        "RUBBISH_CHUTE", 
        "GAS", 
        "FENCING", 
        "CONDITIONER",
        "DISHWASHER"
      ]
    }
  }
}

Аренда дома

В том числе коттеджа, дачи, таунхауса

// Создание объявления по аренде дома
{
  "method": "CreateProperty",
  "request": {
    "requestType": "HouseRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000,
      "currency": "RUR",
      "square": 150,
      "priceType": "MONTH",
      "period": "SEASON",
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "9f63e36c-8f42-42f5",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "landSquare": 10, // Соток
      "landCadastralNumber": "0987654321", // Кадастровый номер для земельного участка
      "houseType": "TOWNHOUSE",
      "distance": 23, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "YES",
      "gas": "BORDER",
      "plumbing": "NO",
      "sewerage": "CENTRAL",
      "relief": "HILLS",
      "furniture": "PART",
      "renovation": "AUTHOR",
      "material": "BRICK",
      "heating": "LOCAL",
      // Дополнительные (не обязательные) поля блока specific
      "landUsageType": "GARDEN",
      "communityName": "Зеленые горки",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции (в минутах в пути).
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 200, // До леса (метров).
      "waterDistance": 500, // До водоема (метров).
      "floorsNumber": 3,
      "toilet": "JOINED",
      "roomsCount": 10,
      "utilities": 5000,
      "utilityMeters": true,  // Оплата по счетчикам производится арендатором (true - оплачивается арендатором. false - оплачивается собственником).
      "otherUtilities": true, // Другие ЖКУ (отопление, капремонт, вывоз мусора и другие услуги) (true - оплачивается арендатором. false - оплачивается собственником).
      "otherUtilitiesPayment": "10000", // Плата за другие ЖКУ (отопление, капремонт, вывоз мусора и другие услуги) в месяц. Обязательно если передается значение "otherUtilities": true.
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "TELEPHONE", 
        "INTERNET", 
        "TV", 
        "GARAGE", 
        "SAUNA", 
        "POOL", 
        "BOILER", 
        "MANSARD", 
        "FOREST", 
        "WATER", 
        "WITH_PETS", 
        "WITH_CHILDREN", 
        "CONDITIONER", 
        "WIRELESS_INTERNET", 
        "FRIDGE", 
        "WASHING_MACHINE",
        "DISHWASHER"
      ]
    }
  }
}

Аренда офиса

// Создание объявления по аренде офиса
{
  "method": "CreateProperty",
  "request": {
    "requestType": "OfficeRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000,
      "currency": "RUR",
      "square": 150,
      "priceType": "MONTH",
      "period": "SEASON",
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parts": [{ // продажа по частям
        "square": 20.0, // площадь части
        "price": 100 // цена части
      }],
      "buildingClass": "A",
      "layout": "FREE",
      "buildingType": "OFFICE_WAREHOUSE",
      "vatType": "VAT_INCLUDED", // НДС включен
      "sublease": true,
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "entryType": "SEPARATE_FROM_YARD",
      "feature": [
        // Допустимые значения
        "REPAIR_BY_OWNER", 
        "ANY_INET_PROVIDER",
        "FIRST_LINE", 
        "RESTAURANT", 
        "FITNESS", 
        "BANK", 
        "ATM", 
        "SUPERMARKET", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL", 
        "ELEVATOR", 
        "CLIENTS_ACCESS", 
        "CONDITIONER", 
        "HEATING", 
        "SEPARATE_ENTRY"
      ]
    }
  }
}

Аренда коммерческого помещения

// Создание объявления по аренде коммерческого помещения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "BusinessRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000,
      "currency": "RUR",
      "square": 150,
      "priceType": "MONTH",
      "period": "SEASON",
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "buildingName": "Светлый"                  // Название ЖК
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parts": [{ // продажа по частям
        "square": 20.0, // площадь части
        "price": 100 // цена части
      }],
      "buildingType": "OFFICE_WAREHOUSE",
      "standaloneBuilding": true,
      "vatType": "VAT_INCLUDED", // НДС включен
      "sublease": true, // Возможна субаренда
      // Дополнительные (не обязательные) поля блока specific
      "readyBusiness": true, // Готовый бизнес
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "WASH",
      "businessUsageTypes": ["GAS_STATION", "WASH"],
      "hallSquare": 100,
      "entryType": "SEPARATE_FROM_YARD",
      "byPart": true, // Можно частями
      "minSquare": 20 // Минимальная площадь
      "feature": [
        // Допустимые значения
        "REPAIR_BY_OWNER", 
        "ANY_INET_PROVIDER", 
        "FIRST_LINE", 
        "RESTAURANT", 
        "FITNESS", 
        "BANK", 
        "ATM", 
        "SUPERMARKET", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL", 
        "EQUIPMENT", 
        "SEPARATE_ENTRY"
      ]
    }
  }
}

Аренда склада

Аренда складского помещения

// Создание объявления по аренде складского помещения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "WarehouseRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000,
      "currency": "RUR",
      "square": 150,
      "priceType": "MONTH",
      "period": "SEASON",
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "subagentPatronymic": "Иванович",
"subagentAvatarUrl": "http://test.local",

      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "sublease": true,
      "vatType": "VAT_INCLUDED", // НДС включен
      "warehouseType": "MIXED",
      "floorsNumber": 5,
      "basementFloor": true,
      "groundFloor": false,
      "floorNumber": 3,
      // Дополнительные (не обязательные) поля блока specific
      "conditioning": "CLIMATE_CONTROL",
      "storageType": "RACK",
      "floorPressure": 100, // Нагрузка на пол (тонн)
      "columnSpace": 10, // Шаг колонн (м)
      "power": 1000, // Подведенная мощьность (кв)
      "floor": "TILE", // Покрытие полов
      "unloading": "CAR_ENTRY",
      "gate": "RAMPANT",
      "highwayAccess": "NONE",
      "ceilingHeight": 500, // Высота потолков (см)
      "year": 2014,
      "entryType": "SEPARATE_FROM_YARD",
      "structureType": "DETACHED",
      "byPart": true, // Можно частями
      "minSquare": 20 // Минимальная площадь
      "feature": [
        // Допустимые значения
        "CRANE", 
        "CUSTOMS", 
        "RAILWAY", 
        "TRUCK_PARKING", 
        "PORT", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL"
      ]
    }
  }
}

Аренда гаража

Аренда гаража

// Создание объявления по аренде гаража
{
  "method": "CreateProperty",
  "request": {
    "requestType": "GarageRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "period": "SEASON",
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "garageType": "STANDALONE",
      "stories": 1,
      // Дополнительные (не обязательные) поля блока specific
      "sublease": true,
      "garageMaterial": "BRICK",
      "ceilingHeight": 500, // Высота потолков (см)
      "year": 2014,
      "totalParkingLots": 2,
      "feature": [
        // Допустимые значения
        "HEATING"
      ]
    }
  }
}

Аренда машиноместа

Аренда машиноместа

// Создание объявления по аренде машиноместа
{
  "method": "CreateProperty",
  "request": {
    "requestType": "ParkingLotRentRequestType",
    "common": {
      "agency": 1, // идентификатор агентства, если объект нужно поместить в агентство
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "contactInfo": {
        "name": "Иннокентий",
        "phone": "71112223334",
        "email": "faedb6b@asdf.ru",
        "company": "Корпорация добра"
      },
      "ownership": "AGENT",
      "commission": 10,
      "commissionType": "PERCENT",
      "exclusiveContract": true,
      "name": "Заголовок объявления",
      "description": "Текстовое описание объявления",
      "price": 27000000,
      "currency": "RUR",
      "square": 150,
      "deposit": 10000,
      "prepayment": 2,
      // Дополнительные (не обязательные) поля блока common
      "period": "SEASON",
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "cityForAvito": "Долгопрудный",
      "subagentContactPhone": "79998887776",
      "phoneEmployeeDomClick": "79998887777",
      "subagentContactEmail": "qwerty@zxcvb.ru",
      "subagentFirstName": "Иван",
      "subagentLastName": "Иванов",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo1.jpg",
            "tags": ["main"]  // Дополнительные теги для фото, позволяют указывать главную фото в объявлении.
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo2.jpg"
            "tags": ["plan"]  // Дополнительный тег для фото, позволяет указать планировку в объявлении. Возможные значения: "plan" или "3d".
        },
        {
            "description": "Описание фото",
            "url": "http://object-promo-page.su/photo3.jpg"
        }
        // Не более 40 фотографий
      ]
    },
    "specific": {
      "parkingLotType": "OPEN",
      // Дополнительные (не обязательные) поля блока specific
      "sublease": true,
      "feature": [
        // Допустимые значения
        "HEATING",
        "GSK"
      ]
    }
  }
}

Методы API

Изменение объекта

Может быть выполнено так же и для опубликованных объектов. В этом случае изменения на сайтах отразятся в течение 24 часов.

// Изменение объявления
{
  "method": "UpdateProperty",
  "request": {
    "requestType": "UpdatePropertyRequestType",
    "id": 345323, // id - объекта на zipal.ru
    "request": {
        // Аналогично запросу на создание объекта
    }
  }
}

Получение списка тарифов

// Получение списка тарифов
{
  "method": "GetPlans",
  "request": {
    "requestType": "GetPlansRequestType",
    "objectType": "FLAT",
    "dealType": "RENT",
    // Указание местонахождения публикуемого объекта в любом из вариантов
    "region": "77", // код региона РФ
    "regionId": 3, // id региона на zipal.ru
    "cityId": 3453, // id города на zipal.ru
    "streetId": 30753 // id улицы на zipal.ru
  }
}

Загрузка фотографий

{
  "method": "UploadPhoto",
  "request": {
    "requestType":"UploadPhotoRequestType",
    "content":"BASE64" // данные, в BASE64,
    "agencyId": 5 // агентство (если нужно наложить водяной знак агентства)
  }
}

Получение информации о ценах

Используйте этот метод для получения информации о ценах на публикацию определенного объекта. Если публикация возможна, используя только свой фид, то в информации о ценах будет стоять feedOnly=true. Для публикации на определенные сайты можете использовать метод CustomPublishRequestType

// Получить информацию о ценах публикации на определенные площадки
{
  "method": "GetPrices",
  "request": {
    "requestType": "GetPricesByObjectRequestType",
    "objectId": 1, // id объекта на zipal.ru
    "days": 3 // кол-во дней
  }
}

// Получить информацию о ценах публикации на определенные площадки
{
  "method": "GetPrices",
  "request": {
      "requestType": "GetPricesByParamsRequestType",
      "days": 3, // количество дней
      "dealType": "SELL", // тип сделки
      "objectType": "FLAT", // тип объекта
      "region": "77", // регион россии
      "hasPhotos": false, // есть ли фотографии
      "room": false, // если комната, то true
      "priceType": "MONTH" // тип цены (необязательный параметр, только для аренды)
  }
}

Получение стоимости custom публикации

Используйте этот метод для получения cтоимости публикации CustomPublishRequestType

// Получить финальную стоимость публикации на определенные площадки (если объект создан, то можно передать objectId)
{
  "method": "GetPrice",
  "request": {
    "requestType": "GetPriceByObjectRequestType",
    "destination": [
      {
        "destination": "IRR",
        "feed": false,
        "placementType": "PREMIUM"
      },
      {
        "destination": "CHOISTER",
        "feed": false,
        "placementType": "REGULAR"
      },
      {
        "destination": "AVITO",
        "feed": true,
        "placementType": "REGULAR"
      },
      {
        "destination": "MAILRU",
        "feed": false,
        "placementType": "REGULAR"
      }
    ],
    "days": 3,
    "objectId": 1
  }
}

// Получить финальную стоимость публикации на определенные площадки (если объекта еще не создан, то можно передать набор параметров)
{
  "method": "GetPrice",
  "request": {
    "requestType": "GetPriceByParamsRequestType",
    "destination": [
      {
        "destination": "IRR",
        "feed": false,
        "placementType": "PREMIUM"
      },
      {
        "destination": "CHOISTER",
        "feed": false,
        "placementType": "REGULAR"
      },
      {
        "destination": "AVITO",
        "feed": true,
        "placementType": "REGULAR"
      },
      {
        "destination": "MAILRU",
        "feed": false,
        "placementType": "REGULAR"
      }
    ],
    "days": 3,
    "dealType": "SELL", // тип сделки
    "objectType": "FLAT", // тип объекта
    "region": "77", // регион россии
    "hasPhotos": false, // есть ли фотографии
    "room": false, // если комната, то true
    "priceType": "MONTH" // тип цены (необязательный параметр, только для аренды)
  }
}

Публикация объявления

После успешного выполнения запроса на публикацию, объявление переходит на модерацию. Статус объекта всегда можно получить при помощи операции GetStatus

// Публикация объекта, используя определенный набор площадок.
// Если объект уже опубликован, то после вызова метода объект будет опубликован на последнем переданном наборе площадок.
// Публикация начинается с текущего момента. Заканчивается через days дней.
{
  "method": "Publish",
  "request": {
    "requestType": "CustomPublishRequestType",
    "objectId": 1, // id объекта на zipal.ru
    "destination": [ // На какие площадки публиковать
      {
        "destination": "IRR",
        "feed": false,
        "placementType": "PREMIUM", // Использовать премиум размещение
        "bet": 10.0 // Используется для публикации объявления со ставкой (ЦИАН.ру)
      },
      {
        "destination": "AVITO",
        "feed": true, // Использовать свой фид,
        "feedName": "custom", // (опционально) можно использовать несколько разных фидов
        "placementType": "REGULAR" // Использовать обычное размещение
      }
    ],
    "days": 3, // кол-во дней
    "autoProlong": true // Автопродление публикации
  }
}

// Публикация объекта, используя заготовленный тариф
{
  "method": "Publish",
  "request": {
    "requestType": "SimplePublishRequestType",
    "objectId": 23543, // id объекта на zipal.ru
    "packetId": 83, // Тариф
    "weeks": 4, // Публикация сроком на 1 месяц (4 недели)
    "autoProlong": true // Автопродление публикации
  }
}


// Публикация объекта по пакетному размещению
{
  "method": "Publish",
  "request": {
    "requestType": "PrepaidPublishRequestType",
    "objectId": 23543, // id объекта на zipal.ru
    "limitId": 3213 // id пакета (не обязательно, для получения см. GetInfo)
  }
}

Снятие объявления с публикации

{
  "method": "Depublish",
  "request": {
    "requestType": "ObjectRequestType",
    "objectId": 23543 // id объекта на zipal.ru
  }
}

Закрытие объявления

// Закрыть объявление (убрать в архив)
{
  "method": "Close",
  "request": {
    "requestType": "CloseRequestType",
    "objectId": 23543, // id объекта на zipal.ru
  }
}

Удаление объявления

// Удалить объявление
{
  "method": "Delete",
  "request": {
    "requestType": "ObjectRequestType",
    "objectId": 23543 // id объекта на zipal.ru
  }
}

Аналитические номера телефонов

Чтобы задать аналитические номера для предоплатного пакета можно воспользоваться следующим методом

//Задать аналитические номера для предоплатного тарифа
{
  "method": "UpdatePrepaidLimitPhones",
  "request": {
    "requestType": "UpdatePrepaidLimitPhonesRequestType",
    "destination": [
      {
        "destination": "AVITO",
        "phone": "79646826112"
      }
    ],
    "limitId": 26251754
  }
}

Также есть возможность задать аналитические номера для каждого объекта в отдельности

//Задать аналитические номера для каждой площадки
{
  "method": "UpdateObjectPhones",
  "request": {
    "requestType": "UpdateObjectPhonesRequestType",
    "objectId": 1,
    "destination": [
      {
        "destination": "GILCOM",
        "phone": "79475933896"
      },
      {
        "destination": "IRR",
        "phone": "79475933560"
      }
    ]
  }
}

Статус объявления

// Получение статуса объявления
{
  "method": "GetStatus",
  "request": {
    "requestType": "GetStatusRequestType",
    "id": 23543 // id объекта на zipal.ru
  }
}

Отчет о размещении

После старта размещения объявления начинает формироваться отчет о размещении. Обычно этот процесс занимает до 24 часов. Получить отчет можно выполнив операцию GetReport.

// Получение отчета о размещенном объявлении
{
  "method": "GetReport",
  "request": {
    "requestType": "GetReportRequestType",
    "id": 23543 // id объекта на zipal.ru
  }
}

Получение информации об ошибках

Чтобы информацию об ошибках, возникших при размещении на площадки, можно воспользоваться следующим методом

// Получение информации об ошибках
{
  "method": "GetErrors",
  "request": {
    "requestType": "GetErrorsRequestType",
    "id": 23543 // id объекта на zipal.ru
  }
}

Статистика

Статистика просмотров объявления

После успешной публикации мы начинаем собирать статистику просмотров размещенных объявлений.

// Получение графика просмотров объявления
{
  "method": "GetAdViews",
  "request": {
    "requestType": "GetAdViewsRequestType",
    "id": 23543, // id объекта на zipal.ru
    "byDestination": true // просмотры по каждой площадке (необязательный параметр)
  }
}

Обозначения

Текстовые обозначения полей

// Список всех текстовых обозначений полей
{
  "method": "GetMessages"
}

Получение объектов

Объекты пользователя

// Получение списка объектов пользователя
{
  "method": "GetObjects",
  "request": {
    "requestType": "GetObjectsRequestType",
    "continuation": "456784435_5670", // Возвращается в ответе при предыдущем вызове
    "count": 20, // Количество объектов
    "addressPresentation": "INTERNAL" // Представление адреса
  }
}

Получение информации

Получение информации по пакетному размещению

// Получение информации по пакетному размещению
{
  "method": "GetInfo"
}

Работа со счетами

Поиск неоплаченных счетов

{
  "method": "FindNotFinishedPayments",
  "request": {"requestType":"FindNotFinishedPaymentsRequestType"}
}

Создание нового счета для оплаты

{
  "method": "CreatePayment",
  "request": {
    "requestType":"CreatePaymentRequestType",
    "amount":1000 // сумма для оплаты в копейках
  }
}
В результате вызова этого метогда может быть 2 типа ответа:
  • BillingInfoRequiredCreatePaymentResponseType - если требуется заполнить реквизиты
  • BillCreatedCreatePaymentResponseType - когда счет успешно создан

Для обновления реквизитов используйте этот метод

{
  "method": "UpdateBillingInfo",
  "request": {
    "requestType":"UpdateBillingInfoRequestType",
    "name":"Zipal", // Полное наименование организации
    "address":"Address", // Почтовый адрес (на какой адрес отправлять закрывающие документы)
    "legalAddress":"Legal Address", // Юридический адрес
    "bank":"Bank", // Название банка
    "ogrn":"7602024742773", // ОГРН
    "inn":"6422500554", // ИНН
    "kpp":"314159143", // КПП
    "account":"38581041899678234170", // Расчетный счет
    "vat":true, // Упрощенная система налогооблажения
    "notificationPeriod":5 // За сколько дней до продления услуги отправлять счет на email,
    "accountantEmail": "some@email.com" // На какой email отправлять счет (если отличается от главного email'а)
  }
}

Чтобы получить счет в pdf используйте метод DownloadBill

{
  "method": "DownloadBill",
  "request": {
    "requestType":"DownloadBillRequestType",
    "id":100282 // идентификатор счета
  }
}

Баланс

Для получения информации о балансе используйте метод GetBalance

// Запрос на получение баланса
{
    "method": "GetBalance",
}

Получение настроек фидов

Чтобы получить текущие настройки фидов и ссылки на них, можно воспользоваться следующим методом

// Получение информации о настройках фидов
{
  "method": "GetFeeds",
  "request": {
    "requestType": "GetFeedsRequestType",
    "agency": 1 // идентификатор агентства, если нужно получить настройки фидов в агентстве
  }
}

Обновление настроек фидов

Чтобы указать или обновить настройки фидов, можно воспользоваться следующим методом

// Обновление настроек фидов
{
  "method": "UpdateFeedsParam",
  "request": {
    "requestType": "UpdateFeedsParamRequestType",
    "agency": 1, // идентификатор агентства, если нужно обновить настройки фидов в агентстве
    "destination":"AFY",
    "param":"password",
    "value":"password_for_AFY"
  }
}

Регистрация пользователя

Чтобы зарегистрировать нового пользователя, можно воспользоваться следующим методом

// Регистрация нового пользователя
{
  "method": "SignUp",
  "request": {
    "requestType": "SignUpRequestType",
    "phone": "+71112223344",
    "email": "ivan@ivanov.ru",
    "name": "ivan"
  }
}

Допустимые значения

Тип сделки

DealType - Тип сделки
Допустимое значение Описание
SELL Продажа
RENT Аренда

Тип объекта

ObjectType - Тип объекта
Допустимое значение Описание
FLAT Квартиры
HOUSE Дома
LAND Земля
COMM_LAND Комм.Земля
BUSINESS Помещения
WAREHOUSE Склады
GARAGE Гаражи
PARKING_LOT Машиноместа

Количество балконов

Balcony - Количество балконов
Допустимое значение Описание
NONE Нет
ONE 1
TWO 2
THREE 3
FOUR 4

Количество лоджий

Loggia - Количество лоджий
Допустимое значение Описание
NONE Нет
ONE 1
TWO 2
THREE 3
FOUR 4

Класс здания

BuildingClass - Класс здания
Допустимое значение Описание
APLUS A+
A A
AMINUS A-
BPLUS B+
B B
C C

Тип здания

BuildingType - Тип здания
Допустимое значение Описание
ADMINISTRATIVE Административное
BANKING Банковское
BUSINESS_CENTER Бизнес-центр
BUSINESS_PARK Бизнес-парк
LIVING_HOUSE Жилой дом
MIXED_COMPLEX Многофункциональный комплекс
MANSION Особняк
MODERN_MANSION Современный особняк
OLD_MANSION Старинный особняк
OFFICE_BUILDING Офисное здание
OFFICE_RESIDENTIAL Офисно-жилой комплекс
OFFICE_WAREHOUSE Офисно-складской комплекс
OFFICE_RETAIL Торгово-офисный комплекс
MALL ТРЦ

Тип использования коммерческого помещения

BusinessUsageType - Тип использования коммерческого помещения
Допустимое значение Описание
ANY Любой
OFFICE Офисное помещение
RETAIL Торговое помещение
PHARMACY Аптека
BEAUTY_SALON Салон красоты
RESTAURANT Ресторан
NIGHT_CLUB Ночной клуб
BAR Бар
GAS_STATION АЗС
WASH Мойка
HOTEL Гостиница
PARKING Парковка
CAR_SERVICE Автосервис

Тип комиссии

CommissionType - Тип комиссии
Допустимое значение Описание
PERCENT %
RUR руб

Состояние коммерческого помещения

Condition - Состояние коммерческого помещения
Допустимое значение Описание
BUSINESS_CLASS Бизнес-класс
READY Готово к въезду
NEED_COSMETIC Требуется косметический ремонт
NEED_OVERHAUL Требуется капитальный ремонт
NEED_RECONSTRUCTION Требуется ремонт здания

Система контроля климата

Conditioning - Система контроля климата
Допустимое значение Описание
NONE Неотапливаемый
HEATING Отапливаемый
COND_AND_VENT Склад-холодильник
CLIMATE_CONTROL Климат-контроль

Валюта

Currency - Валюта
Допустимое значение Описание
RUR руб
USD долл
EUR евро

Опции

Feature - Опции
Допустимое значение Описание
INTERNET Интернет
TELEPHONE Телефон
TV Спутниковое / Кабельное ТВ
ELEVATOR Лифт
SERVICE_ELEVATOR Грузовой лифт
CONCIERGE Консьерж
GUARDS Охраняемая территория
RUBBISH_CHUTE Мусоропровод
GAS Газ
FENCING Огороженная территория
INVALIDS Доступно людям с ограниченными возможностями
WASHING_MACHINE Стиральная машина
FURNITURE Мебель
FRIDGE Холодильник
CONDITIONER Кондиционер
WIRELESS_INTERNET Беспроводной интернет
WITH_PETS С животными
WITH_CHILDREN С детьми
ACCESS Круглогодичный доступ
GARAGE Гараж
SAUNA Баня / Сауна
POOL Бассейн
BOILER Бойлер
MANSARD Мансарда
RESIDENCE Возможна прописка
FOREST Лес
WATER Водоем
CLOCK_ACCESS Доступ 24 часа
VIDEO_SURVEILLANCE Видео-наблюдение
ACCESS_CONTROL Контроль доступа
CRANE Кран
CUSTOMS Таможня
RAILWAY Жд сообщение
TRUCK_PARKING Парковка для грузового транспорта
PORT Порт
ANY_INET_PROVIDER Возможность менять провайдера
FIRST_LINE Первая линия
RESTAURANT Ресторан
FITNESS Фитнес
BANK Банк
ATM Банкомат
SUPERMARKET Супермаркет
CLIENTS_ACCESS Доступ для клиентов
HEATING Отопление
SEPARATE_ENTRY Отдельный вход
EQUIPMENT Есть оборудование
REPAIR_BY_OWNER Ремонт за счет владельца
GSK На территории ГСК или ГК
DISHWASHER Посудомоечная машина
INTERCOM Домофон
WATER_METER Счетчики воды
ELECTRIC Электричество
GRACE_PERIOD Арендные каникулы
BUFFET Буфет
CANTEEN Столовая
CAFE Кафе
CINEMA Кинотеатр
NOTARY_OFFICE Нотариальная контора
CONFERENCE_ROOM Конференц-зал
MINIMARKET Минимаркет
RAMP Пандус
TERRACE Терраса
SLAVIC

Тип расстояния

DistanceType - Тип расстояния
Допустимое значение Описание
WALK пешком
TRANSPORT транспортом

Электроснабжение

Electricity - Электроснабжение
Допустимое значение Описание
NO Отсутствует
YES Подключено
POSSIBLE Возможно подключение
AUTONOM Автономное

Статус объекта

FlatStatus - Статус объекта
Допустимое значение Описание
ALTERNATIVE Альтернатива
FREE Свободна

Тип квартиры

FlatType - Тип квартиры
Допустимое значение Описание
FLAT Типовая
STUDIO Студия
ELITE Элитная
TWO_LEVEL Двухуровневая
INDIVIDUAL Индивидуальная
IMPROVED Улучшенная планировка
PENTHOUSE Пентхаус
MALOSEMEIKA Малосемейка
GOSTINKA Гостинка

Мебель

Furniture - Мебель
Допустимое значение Описание
FULL Полностью мебелирован
PART Частично мебелирован
NONE Отсутствует

Газификация

Gas - Газификация
Допустимое значение Описание
NO Отсутствует
YES Подведен
BORDER По границе
POSSIBLE Возможно подключение
GASBOTTLE Газовый баллон
GASHOLDER Газгольдер
AUTONOM Автономная

Въезд

Gate - Въезд
Допустимое значение Описание
ZERO_POINT Ворота на нулевой отметке
HYUDRALIC_RAMPS Гидроаппарели и докшелтеры
RAMPANT Пандус или рампа

Отопление

Heating - Отопление
Допустимое значение Описание
CENTRAL Центральное
LOCAL Отдельное
GAS Газовое
ELECTRICITY Электрическое
LIQUID Жидкое топливо
FURNACE Печь
FIREPLACE Камин
NONE Отсутствует

Транспортная доступность

HighwayAccess - Транспортная доступность
Допустимое значение Описание
NONE Отсутствует
TWO_TURNS Не более двух поворотов
DIRECT_ACCESS Прямой доступ

Тип дома

HouseType - Тип дома
Допустимое значение Описание
DACHA Дача
COTTAGE Коттедж
TOWNHOUSE Таунхаус
DUPLEX Дуплекс
HOUSE Дом
HOUSESHARE Часть дома

Использование земли

LandUsageType - Использование земли
Допустимое значение Описание
IGS ИЖС(индивидуальное жилищное строительство)
LPH ЛПХ(личное подсобное хозяйство)
DNP ДНП(дачное некоммерческое партнерство)
SNT СНТ(садоводческое некоммерческое товарищество)
FARM Фермерское хозяйство
GARDEN Садоводство

Планировка

Layout - Планировка
Допустимое значение Описание
CORRIDOR Кабинетная
FREE Свободная
MIXED Смешанная

Материал стен

FlatMaterial - Материал стен
Допустимое значение Описание
BRICK Кирпич
PANEL Панель
MONOLITH Монолит
MONOBRICK Монолит-кирпич
WOOD Дерево
BLOCK Блок

Материал стен

HouseMaterial - Материал стен
Допустимое значение Описание
BRICK Кирпич
CONCRETE Железобетон
MONOLITH Монолит
TIMBER Брус
WOOD Дерево
BLOCK Блок
WIREFRAME Каркасный
BOARDS Щитовой
FOAM Пенобетон
AEROCRETE Газобетон
ARBOLIT Арболит
EXPANDEDCLAYCONCRETE Арболит
SANDWICH Сэндвич-панели

Материал стен

GarageMaterial - Материал стен
Допустимое значение Описание
BRICK Кирпич
CONCRETE Железобетон
METAL Металлоконструкции

Новостройка

NewFlat - Новостройка
Допустимое значение Описание
READY Новостройка
NOT_READY Долевое

Собственность

Ownership - Собственность
Допустимое значение Описание
OWNER Я являюсь собственником
AGENT Я являюсь агентом

Тип парковки

ParkingType - Тип парковки
Допустимое значение Описание
ON_GROUND Наземная
MULTILEVEL Многоуровневая
ROOF На крыше
UNDER_GROUND Подземная

Срок аренды

Period - Срок аренды
Допустимое значение Описание
SHORT Короткий
LONG Длительный
SEASON Сезонный
MORE_THAN_MONTH Месяц и более

Водоснабжение

Plumbing - Водоснабжение
Допустимое значение Описание
NO Отсутствует
CENTRAL Центральное
HOLE Скважина
WELL Колодец/колонка
BORDER По границе

Период оплаты

PriceType - Период оплаты
Допустимое значение Описание
MONTH месяц
DAY сутки

Назначение земли

Purpose - Назначение земли
Допустимое значение Описание
SETTLEMENTS Земли поселений
AGRICULTURAL Сельскохозяйственного назначения
INDUSTRIAL Промышленного назначения
FORESTS Земли лесного фонда
AQUA Земли водного фонда
GUARDED Особо охраняемых территорий
RESERVATIONS Запаса

Квартал

Quarter - Квартал
Допустимое значение Описание
I Первый квартал
II Второй квартал
III Третий квартал
IV Четвертый квартал

Рельеф

Relief - Рельеф
Допустимое значение Описание
FLAT Ровный
ELEVATIONS Значительные перепады высот
SLOPE Склон
HILLS Холмы

Ремонт

Renovation - Ремонт
Допустимое значение Описание
COSMETIC Косметический
EURO Евростандарт
NONE Под отделку
NEEDS_RENOVATION Требует ремонта
ROUGH_FINISH Черновая отделка
AUTHOR Авторский

Канализация

Sewerage - Канализация
Допустимое значение Описание
NO Отсутствует
CESSPOOL Выгребная яма
SEPTIC Септик
BIO Устройства биологической очистки
CENTRAL Центральная

Форма участка

Shape - Форма участка
Допустимое значение Описание
REGULAR Правильная
IRREGULAR Не правильная

Тип хранения

StorageType - Тип хранения
Допустимое значение Описание
FLOOR Напольное
RACK Стелажное
MIXED Смешанное

Туалет

Toilet - Туалет
Допустимое значение Описание
JOINED Совмещенный
SEPARATED Раздельный
OUTDOORS На улице
TWO 2
THREE 3
FOUR 4

Разгрузка

Unloading - Разгрузка
Допустимое значение Описание
RAMPANT Пандус
NON_RAMPANT Без пандуса
CAR_ENTRY Въезд на склад

Покрытие полов

WarehouseFloor - Покрытие полов
Допустимое значение Описание
LEVELCRETE Бетонный пол
LINOLEUM Линолеум
ASPHALT Асфальт
TILE Бетонная плитка
WOOD Дерево
LAMINATE Ламинат
REINFORCED_CONCRETE Железобетон
POLYMERIC Полимерный

Тип складского помещения

WarehouseType - Тип складского помещения
Допустимое значение Описание
WAREHOUSE Склад
CONSTRUCTION Производство
MIXED Смешанное

Вид из окна

WindowView - Вид из окна
Допустимое значение Описание
STREET На улицу
YARD Во двор
BOTH Во двор и на улицу

Вход в объект

EntryType - Вход в объект
Допустимое значение Описание
SEPARATE_FROM_YARD Отдельный со двора
SEPARATE_FROM_STREET Отдельный с улицы
JOINT_FROM_YARD Общий со двора
JOINT_FROM_STREET Общий с улицы
CHECKPOINT Через проходную
SEVERAL Несколько, включая отдельный
SEVERAL_JOINT Несколько, все общие

Тип ванны

BathType - Тип ванны
Допустимое значение Описание
SHOWER Душ
JOINED Совмещенная
SEPARATED Отдельная
CROSS Поперечная
LONGITUDINAL Продольная
SEDENTARY Сидячая
KITCHEN На кухне
CORRIDOR В коридоре
NO Нет ванны

Обеспечение горячей водой

HotWater - Обеспечение горячей водой
Допустимое значение Описание
CENTRAL Теплоцентр
BOILER Бойлер
GAS_COLUMN Газовая колонка
ELECTRICITY Электроводонагреватель
WOOD_STOVE Дровяная колонка
NONE Нет

Тип предложения

OfferType - Тип предложения
Допустимое значение Описание
FLAT Вся квартира
ROOM Комната
FLATSHARE Доля в квартире

Тип гаража

GarageType - Тип гаража
Допустимое значение Описание
STANDALONE Отдельный гараж
BOX Бокс
SHELL Ракушка
CASE Пенал
SUNSHADE Тент-укрытие

Тип стоянки

ParkingLotType - Тип стоянки
Допустимое значение Описание
OPEN Открытая
CLOSED Закрытая
MULTILEVEL Многоуровневая

Тип здания

StructureType - Тип здания
Допустимое значение Описание
DETACHED Отдельно стоящее здание

Налог

VatType - Налог
Допустимое значение Описание
VAT_NOT_INCLUDED НДС не включен
VAT_INCLUDED НДС включен
USN УСН

Дольщик

InvestorType - Дольщик
Допустимое значение Описание
INDIVIDUAL Физ. лицо
LEGAL Юр. лицо

Пассажирских лифтов

Elevator - Пассажирских лифтов
Допустимое значение Описание
NONE Нет
ONE 1
TWO 2
THREE 3
FOUR 4

Грузовых лифтов

ServiceElevator - Грузовых лифтов
Допустимое значение Описание
NONE Нет
ONE 1
TWO 2
THREE 3
FOUR 4

Тип дома

FlatHouseType - Тип дома
Допустимое значение Описание
BREZHNEVKA Брежневка
LOW_FLOOR Малоэтажка
HOSTEL Общежитие
SECTION Секционного типа
SPECIAL Спецпроект
STALINKA Сталинка
HRUSHEVKA Хрущевка
OLD_FUND Старый фонд
MODERN_HOUSE_BUILDING Современное домостроение

Входная дверь

Door - Входная дверь
Допустимое значение Описание
WOOD Деревянная
METAL Металлическая
METAL_WOOD Двойная металл-дерево
WOOD_METAL Двойная дерево-металл

Покрытие пола

FlatFloor - Покрытие пола
Допустимое значение Описание
LINOLEUM Линолеум
LAMINATE Ламинат
CARPETING Ковролин
PARQUET Паркет
BATTEN Половая доска
NO Без покрытия

Расположение в доме

ApartmentPosition - Расположение в доме
Допустимое значение Описание
CORNER Угловая квартира
NOT_CORNER Неугловая квартира

Окна

WindowMaterial - Окна
Допустимое значение Описание
WOOD Деревянные
PLASTIC Пластиковые ПВХ

Представление адреса

AddressPresentationType - представление адреса
Допустимое значение Описание
INTERNAL В виде набора внутренних id (cityId и streetId)
KLADR В виде кода КЛАДР
STRING В виде строки