Документация по 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 запроса

OAuth 2.0

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

Регистрация приложения

Для работы через OAuth 2.0 необходимо зарегистрировать приложение. Укажите в запросе на подключение как будет называться ваше приложение. Запрос составляется в свободной форме.

Cоздать запрос на подключение

После чего вы получаете:

YOUR_APP - имя в нашей системе		
YOUR_SECRET - пароль для получения access_token

Доступ приложения к аккаунту

Пользователь подтверждает доступ вашего приложения к своему аккаунту на Zipal.ru.

Запрос

https://zipal.ru/oauth/authorize?client_id={YOUR_APP}&redirect_uri=http://{SUCCESS_REDIRECT_URL}&response_type=code

YOUR_APP - имя вашего приложения зарегистрированное в нашей системе

SUCCESS_REDIRECT_URL - ссылка на которую будет перенаправлен пользователь после успешного подтверждения доступа для вашего приложения

Ответ

http://{SUCCESS_REDIRECT_URL}?code={ACCESS_TOKEN_GENERATE_CODE}

ACCESS_TOKEN_GENERATE_CODE - код для получения access_token

Получение токена авторизации

Ваше приложение получает access_token для пользователя.

Запрос

https://zipal.ru/oauth/token?client_id={YOUR_APP}&client_secret={YOUR_SECRET}&grant_type=authorization_code&redirect_uri=http://{SUCCESS_REDIRECT_URL}&code={ACCESS_TOKEN_GENERATE_CODE}

YOUR_APP - имя вашего приложения зарегистрированное в нашей системе

YOUR_SECRET - пароль для получения access_token

http://SUCCESS_REDIRECT_URL - адрес указанный при получении доступа

ACCESS_TOKEN_GENERATE_CODE - код для получения access_token

Ответ

{
  "access_token"  : "164fk4mf-one1-l6ow-ake5-7e2kvdkhh7bi",
  "token_type"    : "bearer",
  "refresh_token" : "r6wuwqg1-9v15-y7vq-nnxo-nbmj4ucpcu9z",
  "expires_in"    : 31643
}

Авторизация запросов

Для отправки авторизации запроса достаточно добавить access_token в запрос.

Запрос

// access_token передается в запросе
{
  "oauth": "164fk4mf-one1-l6ow-ake5-7e2kvdkhh7bi",
  "request": {
    // Тело запроса
  }
}

Обновление токена авторизации

С течением времени access_token устаревает и становится не активным. Для обновления токена авторизации выполните запрос.

Запрос

https://zipal.ru/oauth/token?client_id=YOUR_APP&client_secret=YOUR_SECRET&refresh_token=r6wuwqg1-9v15-y7vq-nnxo-nbmj4ucpcu9z&grant_type=refresh_token

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": {
      "address": {
        "street": {
          "type": "SimpleStreetType",
          "name": "Московская область, г. Долгопрудный, ул. Московская",
          "allowWeak": true
        },
        "coordinates": { // Не обязательно
          "lat": 55.954154,
          "lon": 37.512461
        },
        "dom": "3А"
      },
      "metros": { // Не обязательно, определяется автоматически
        "metro": [
          {
            "id": 100, // идентификатор или
            "name": "Проспект Вернадского", // название станции
          }
        ]
      },
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "type[FlatType]": "APARTMENTS",
      "roomsCount": 5,
      "roomsCountTotal": 5,
      "separatedRoomsCount": 5,
      "floorNumber": 10,
      "floorsNumber": 15,
      "material": "MONOLITH",
      "credit": true, // Рассрочка
      "mortgage": true, // Ипотека
      // Дополнительные (не обязательные) поля блока specific
      "usefulSquare": 120,
      "kitchenSquare": 15,
      "ceilingHeight": 300, // Сантиметров
      "developer": "Монолит",
      "buildingName": "ЖК Новостройка", //Название ЖК (обязательно для новостроек)
      "documentationUrl": "https://zipal.ru", //Ссылка на проектную документацию (обязательно для новостроек)
      "series": "П44Т", // Серия дома
      "flatStatus": "ALTERNATIVE",
      "renovation": "NONE",
      "toilet": "THREE",
      "balcony": "BALCONY",
      "heating": "LIQUID",
      "newFlat": "READY",
      "readyDate": {
        "quarter": "I",
        "year": 2014
      },
      "feature": [
        // Допустимые значения
        "INTERNET", 
        "TELEPHONE", 
        "TV", 
        "INVALIDS", 
        "ELEVATOR", 
        "SERVICE_ELEVATOR", 
        "CONCIERGE", 
        "GUARDS", 
        "RUBBISH_CHUTE", 
        "GAS", 
        "FENCING"
      ]
    }
  }
}

Продажа дома

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

// Создание объявления по продаже дома
{
  "method": "CreateProperty",
  "request": {
    "requestType": "HouseSellRequestType",
    "common": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "landSquare": 10, // Соток
      "houseType": "TOWNHOUSE",
      "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": "Зеленые горки",
      "cadastralNumber": "9f63e36c-8f42-42f5",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции км.
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 2, // До леса км.
      "waterDistance": 5, // До водоема км.
      "floorsNumber": 3,
      "toilet": "JOINED",
      "roomsCount": 10,
      "feature": [
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "TELEPHONE", 
        "INTERNET", 
        "TV", 
        "GARAGE", 
        "SAUNA", 
        "POOL", 
        "BOILER", 
        "MANSARD", 
        "RESIDENCE", 
        "FOREST", 
        "WATER"
      ]
    }
  }
}

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

// Создание объявления по продаже земли
{
  "method": "CreateProperty",
  "request": {
    "requestType": "LandSellRequestType",
    "common": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "purpose": "FORESTS",
      "distance": 100, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "POSSIBLE",
      "gas": "NO",
      "plumbing": "HOLE",
      "sewerage": "CESSPOOL",
      "relief": "SLOPE",
      "shape": "REGULAR",
      // Дополнительные (не обязательные) поля блока specific
      "landUsageType": "SNT", // Обязательно, если purpose: SETTLEMENTS или AGRICULTURAL
      "communityName": "Зеленые горки",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции км.
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 2, // До леса км.
      "waterDistance": 5, // До водоема км.
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "FOREST", 
        "WATER"
      ],
    }
  }
}

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

// Создание объявления по продаже офиса
{
  "method": "CreateProperty",
  "request": {
    "requestType": "OfficeSellRequestType",
    "common": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "buildingClass": "C",
      "layout": "FREE",
      "buildingType": "OFFICE_WAREHOUSE",
      "vatIncluded": true, // НДС включен
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "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": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "buildingType": "OFFICE_WAREHOUSE",
      "vatIncluded": true, // НДС включен
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "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": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "sublease": true,
      "vatIncluded": true,
      "warehouseType": "MIXED",
      "floorsNumber": 5,
      // Дополнительные (не обязательные) поля блока 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,
      "feature": [
        // Допустимые значения
        "CRANE", 
        "CUSTOMS", 
        "RAILWAY", 
        "TRUCK_PARKING", 
        "PORT", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL"
      ]
    }
  }
}

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

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

// Создание объявления по продаже земли коммерческого назначения
{
  "method": "CreateProperty",
  "request": {
    "requestType": "CommLandSellRequestType",
    "common": {
      "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",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "purpose": "FORESTS",
      "distance": 100, // Удаленность от районного центра км.
      "burden": true, // Есть обременения
      "electricity": "POSSIBLE",
      "gas": "NO",
      "plumbing": "HOLE",
      "sewerage": "CESSPOOL",
      "relief": "SLOPE",
      "shape": "REGULAR",
      // Дополнительные (не обязательные) поля блока specific
      "landUsageType": "SNT", // Обязательно, если purpose: SETTLEMENTS или AGRICULTURAL
      "communityName": "Зеленые горки",
      "cadastralNumber": "4c37-baf4-500b4b9b5bd4",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции км.
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 2, // До леса км.
      "waterDistance": 5, // До водоема км.
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "FOREST", 
        "WATER"
      ],
    }
  }
}

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

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

// Создание объявления по аренде квартиры
{
  "method": "CreateProperty",
  "request": {
    "requestType": "FlatRentRequestType",
    "common": {
      "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,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "type[FlatType]": "HRUSHEVKA",
      "roomsCount": 2,
      "roomsCountTotal": 2,
      "separatedRoomsCount": 2,
      "floorNumber": 5,
      "floorsNumber": 8,
      "material": "PANEL",
      // Дополнительные (не обязательные) поля блока specific
      "usefulSquare": 120,
      "kitchenSquare": 15,
      "ceilingHeight": 300, // Сантиметров
      "renovation": "NONE",
      "toilet": "JOINED",
      "balcony": "BALCONY",
      "series": "П44Т",
      "heating": "LIQUID",
      "maxPeople": 4,
      "feature": [
        "INTERNET", 
        "TELEPHONE", 
        "TV", 
        "INVALIDS", 
        "WASHING_MACHINE", 
        "FURNITURE", 
        "FRIDGE", 
        "WIRELESS_INTERNET", 
        "WITH_PETS", 
        "WITH_CHILDREN", 
        "ELEVATOR", 
        "SERVICE_ELEVATOR", 
        "CONCIERGE", 
        "GUARDS", 
        "RUBBISH_CHUTE", 
        "GAS", 
        "FENCING", 
        "CONDITIONER"
      ]
    }
  }
}

Аренда дома

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

// Создание объявления по аренде дома
{
  "method": "CreateProperty",
  "request": {
    "requestType": "HouseRentRequestType",
    "common": {
      "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,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "landSquare": 10, // Соток
      "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": "Зеленые горки",
      "cadastralNumber": "9f63e36c-8f42-42f5",
      "railway": "Космическая станция",
      "railwayDistance": 1, // До жд. станции км.
      "railwayDistanceType[DistanceType]": "TRANSPORT",
      "forestDistance": 2, // До леса км.
      "waterDistance": 5, // До водоема км.
      "floorsNumber": 3,
      "toilet": "JOINED",
      "roomsCount": 10,
      "feature": [
        // Допустимые значения
        "GUARDS", 
        "FENCING", 
        "ACCESS", 
        "TELEPHONE", 
        "INTERNET", 
        "TV", 
        "GARAGE", 
        "SAUNA", 
        "POOL", 
        "BOILER", 
        "MANSARD", 
        "FOREST", 
        "WATER", 
        "WITH_PETS", 
        "WITH_CHILDREN", 
        "CONDITIONER", 
        "WIRELESS_INTERNET", 
        "FRIDGE", 
        "WASHING_MACHINE"
      ]
    }
  }
}

Аренда офиса

// Создание объявления по аренде офиса
{
  "method": "CreateProperty",
  "request": {
    "requestType": "OfficeRentRequestType",
    "common": {
      "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,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "buildingClass": "A",
      "layout": "FREE",
      "buildingType": "OFFICE_WAREHOUSE",
      "vatIncluded": true, // НДС включен
      "sublease": true,
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "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": {
      "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,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "buildingType": "OFFICE_WAREHOUSE",
      "vatIncluded": true, // НДС включен
      "sublease": true, // Возможна субаренда
      // Дополнительные (не обязательные) поля блока specific
      "floorNumber": 5,
      "floorsNumber": 8,
      "objectCondition": "READY",
      "centerName": "Космос Плаза",
      "parkingPlaces": 300,
      "parkingType": "UNDER_GROUND",
      "ceilingHeight": 400, // В сантиметрах
      "year": 2010, // Год постройки
      "businessUsageType": "ANY",
      "hallSquare": 100,
      "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": {
      "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,
      // Дополнительные (не обязательные) поля блока common
      "distanceToMetro": 10,
      "distanceType": "TRANSPORT",
      "videoUrl": "http://youtube.com/videoUrl", // Видео с сервиса youtube
      "url": "http://object-promo-page.su",
      "photos": [
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo1.jpg"
        },
        {
          "description": "Описание фото",
          "url": "http://object-promo-page.su/photo2.jpg"
        }
        // Не более 20 фотографий
      ]
    },
    "specific": {
      "sublease": true,
      "vatIncluded": true,
      "warehouseType": "MIXED",
      "floorsNumber": 5,
      // Дополнительные (не обязательные) поля блока 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,
      "feature": [
        // Допустимые значения
        "CRANE", 
        "CUSTOMS", 
        "RAILWAY", 
        "TRUCK_PARKING", 
        "PORT", 
        "INTERNET", 
        "CLOCK_ACCESS", 
        "VIDEO_SURVEILLANCE", 
        "GUARDS", 
        "ACCESS_CONTROL"
      ]
    }
  }
}

Методы 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
  }
}

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

Используйте этот метод для получения информации о ценах на публикацию определенного объекта. Если публикация возможна, используя только свой фид, то в информации о ценах будет стоять 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" // Использовать премиум размещение
      },
      {
        "destination": "AVITO",
        "feed": true, // Использовать свой фид
        "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": "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": "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 // идентификатор счета
  }
}

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

Тип сделки

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

Тип объекта

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

Балкон

Balcony - Балкон
Допустимое значение Описание
BALCONY Балкон
LOGGIA Лоджия

Класс здания

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

Тип здания

BuildingType - Тип здания
Допустимое значение Описание
ADMINISTRATIVE Административное
BANKING Банковское
BUSINESS_CENTER Бизнес-центр
BUSINESS_PARK Бизнес-парк
LIVING_HOUSE Жилой дом
MIXED_COMPLEX Многофункциональный комплекс
STAND_ALONE_BUILDING Отдельно стоящее здание
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 Парковка

Тип комиссии

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 Ремонт за счет владельца
SLAVIC

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

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

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

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

Статус квартиры

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

Тип квартиры

FlatType - Тип квартиры
Допустимое значение Описание
FLAT Типовая
STUDIO Студия
ELITE Элитная
PENTHOUSE Пентхаус
APARTMENTS Апартаменты
HOSTEL Общежитие
MALOSEMEIKA Малосемейка
GOSTINKA Гостинка
HRUSHEVKA Хрущевка
STALINKA Сталинка

Мебель

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

Газификация

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

Въезд

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

Отопление

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

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

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

Тип дома

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

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

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

Планировка

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

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

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

Новостройка

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

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

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

Тип парковки

ParkingType - Тип парковки
Допустимое значение Описание
ON_GROUND Наземная
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 Под отделку
AUTHOR Авторский

Канализация

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

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

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

Тип хранения

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

Туалет

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

Разгрузка

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

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

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

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

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

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

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