Взаємодія з системою Plektan здійснюється за допомогою запитів POST на URL

  http(s)://re.plektan.com/[lang]/[API_section]/[command]

Параметр [lang] може приймати значення 'uk' (українська) або 'ru' (російська).
Параметри [API_section] та [command] будуть описані нижче у відповідних розділах.
Приклад:

Мова: uk (українська)
Секція: API_serp (списки оголошень)
Команда: search (пошук оголошень)

URL запиту: http(s)://re.plektan.com/uk/API_serp/search

У кожному POST запиті повинні передаватися набір статичних параметрів, загальних всім запитів, і додатково — параметри, специфічні цього запиту.
У разі вдалого запиту відповідь надходить у json-форматі.

1. Параметри, які спільні для всіх запитів

У кожному запиті повинні передаватись параметри авторизації, версії API та ін.
У таблиці нижче наведено ці параметри. Зірочкою відзначені обов'язкові.

2. Секція [API_serp]

Ця секція використовується для отримання серпу (списку) об'яв за заданими фільтрами.

2.1 Команда [search]

У таблиці наведено параметри, що передаються в цій команді. Зірочкою відзначені обов'язкові параметри.

API системи Plektan дозволяє здійснювати пошук за номером оголошення або параметрами оголошення. Набір запитів, що передаються, залежить від типу пошуку.
У результатах пошуку не передаються неактуальні оголошення: червоні (застарілі), відкладені, що знаходяться в угоді та закриті.

2.1.1 Пошук за номером

2.1.2 Пошук за параметрами

Набір пошукових параметрів (фільтрів), що передаються, залежить від типу нерухомості (property).

Наведений набір фільтрів для різних типів нерухомості є рекомендованим.

2.1.3 Формат відповіді

Відповідь на команду [search] надходить у наступному форматі:

Array[2]
   data => Array[20]			// масив знайдених оголошень
      0 => Array[39]
         [advert fields]		// поля оголошення 1
      1 => Array[39]
         [advert fields]		// поля оголошення 2
      ...
      19 => Array[39]
         [advert fields]		// поля оголошення 20
   totalRows => "1370"			// загальна кількість знайдених оголошень

Поля одержуваних оголошень докладно описані у пункті Формат оголошень у пошуку.
Якщо в налаштуваннях API для цієї компанії увімкнено функцію отримання статистики при пошуку оголошень, додатково надходить список граничних значень цін і площ для набору оголошень, обмеженого вказаними фільтрами, у наступному форматі:

 stat =>Array[6]
      price_max =>"8100000.38"
      price_min =>"25000.00"
      area_total_max =>"460.00"
      area_total_min =>"1.00"
      area_lot_max =>""
      area_lot_min =>""

При отриманні статистики фільтри за ціною та площею ігноруються.

3. Секція [API_view]

У цій секції представлені команди отримання докладних даних про оголошення (для картки оголошення - сторінки «оголошення докладно») та додавання оголошень до системи через сайт компанії.

3.1 Команда [view]

Команда служить для отримання картки оголошення.

Формат відповіді описаний у розділі Поля оголошень в оголошенні детально (картці).

3.2 Команда [addAdvert]

Команда служить для надсилання оголошення до системи Plektan. Такі оголошення потрапляють до бази неперевірених оголошень (наводок) компанії з позначкою «З сайту компанії».
Набір полів в оголошеннях з продажу та здавання в оренду відрізняється від набору полів оголошень з купівлі та пошуку для оренди.
Є також поля, властиві всім оголошенням, що подаються:

У додаткову інформацію можна надсилати інформацію, яка не представлена ​​в інших параметрах.

3.2.1 Оголошення продажу та здачі в оренду

Поля, які передаються в команді, представлені в таблиці.

Формат відповіді описаний у Формат відповіді.

3.2.2 Оголошення купівлі та пошуку для оренди

Поля, які передаються в команді, представлені в таблиці.

Формат відповіді описаний у Формат відповіді.

3.2.3 Швидка подача на основі існуючого оголошення

Таким шляхом можна подати лише оголошення купівлі та пошуку для оренди. Замість відправки полів оголошення «куплю» або «зніму», можна відправити реєстраційний номер оголошення «продам» або «здам» відповідно, на основі якого система сама сформує контр-оголошення та додасть його до системи.
Поля, що передаються в команді, представлені в таблиці (вони замінюють набір полів, вказаних на початку розділу Команда [addAdvert]).

Формат відповіді описаний у Формат відповіді.

3.2.4 Формат відповіді

Відповідь на команду надсилання оголошення має наступний формат:

Array[3]
   result =>"ADDED"
   item_id =>"104908"
    message =>""Наводку" додано до системи з id 104908"

У полі result приходить результат додавання (ADDED, PARSE_ERROR і т.д.). У полі item_id надходить ідентифікатор (id, номер) наведення, доданого до системи.
У полі message приходить опис помилки у разі неможливості додати наведення до системи.

3.3 Команда [uploadAdvertPhoto]

Допоміжна команда служить для надсилання фотографій об'єкта в систему Plektan перед викликом команди [addAdvert] (для оголошень типу «Продам» та «Здам»).

Функція завантаження медіафайлів передбачає можливість одночасного завантаження кількох файлів. Тому навіть при завантаженні одного файлу параметр, що передається, повинен бути масивом — photoUpload[0].
Приклад коду на PHP для "прокидання" завантажених з браузера клієнта файлів з використанням бібліотеки CURL:

$files = $_FILES['photoUpload'];


for ($i = 0, $l = sizeof($files['tmp_name']); $i < $l; $i++) {
	$filename = basename($files['name'][$i]);
	$filetype = $files['type'][$i];
	$filepath = $files['tmp_name'][$i];


	$cfile = new \CURLFile($filepath, $filetype, $filename);
	$post["photoUpload[$i]"] = $cfile;
}
...
$ch = curl_init();
...
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
...
$result = curl_exec($ch);
...

Формат відповіді на цю команду наступний:

Array[3]
   result =>"SAVED"						// результат завантаження
   data =>Array[2]						// звіт про завантажені файли
      0 =>Array[3]
         media_id =>"17622"					// id медіафайлу
         title =>""						// підпис до фото
         src =>"http://domain/p1.small.jpg"		// URL фото
      1 =>Array[3]
         media_id =>"17623"					// — - —
         title =>""
         src =>"http://domain/p2.small.jpg"	
      ...

Отриману інформацію по media_id можна використовувати в команді [addAdvert] для додавання оголошення з прив'язаними медіафалами.

4. Секція [API_geo]

4.1 Команди пошуку географії

Команди пошуку географії застосовуються реалізації полів інтерактивного пошуку у списках географії з великою кількістю елементів (вулиці, населені пункти області). Такі списки немає сенсу показувати відвідувачам сайту через їх великий обсяг і незручність орієнтування в такому списку.
Як правило, поля інтерактивного пошуку використовуються на формах подачі оголошень з сайту. Пошук у таких полях є сенс починати, коли введено хоча б три символи.
Порядок пошуку, що відправляється, автоматично конвертується в кирилицю, якщо у користувача в момент введення стоїть латинська розкладка. Пошук здійснюється як за ідентифікатором, так і за значенням.
Максимальна кількість елементів у відповіді — 16. Перші 15 служать для відображення відвідувачу сайту, 16 можна використовувати для визначення, чи всі елементи, що відповідають рядку, прийшли у відповіді, чи є ще.

4.1.1 Команда [findCity]

Ця команда служить для одержання списку населених пунктів області з підрядку — початку назви населеного пункту.

Відповідь надходить у наступному форматі:

Array[8]
   0 =>Array[10]
      locality_id =>"Іванівка"			// ідентифікатор locality_id
      locality =>"Іванівка"				// відображуване значення
      country_id =>"Ukraine"				// ідентифікатор country_id
      region_id =>"Чугуївський район"		// ідентифікатор region_id району
      region =>"Чугуївський район"			// відображуване значення
      is_capital =>""					// чи є районним центром?
      parent_region_id =>"Харківська область"	// ідентифікатор region_id області
   1 =>Array[10]
      locality_id =>"Іванівка"
      locality =>"Іванівка"
      country_id =>"Ukraine"
      region_id =>"Барвінківський район"
      ...
   ...

Параметр is_capital можна використовувати для того, щоб у списку населених пунктів, що відображається відвідувачеві, районні центри виділяти будь-яким чином.
У відповіді населені пункти сортуються спочатку за параметром is_capital (районні центри вище), потім алфавітом.

4.1.2 Команда [findStreet]

Ця команда служить для отримання списку вулиць населеного пункту за підрядком — на початку назви вулиці.

Відповідь надходить у наступному форматі:

Array[6]
   0 =>Array[3]
      street_id =>"Академіка Єфремова вул."		// ідентифікатор вулиці street_id
      street =>"Академіка Єфремова вул."		// відображуване значення
      aliases =>"(Уборевича Командарма ул.)"			// старі назви (якщо є)
   1 =>Array[3]
      street_id =>"Академіка Ромоданова вул."
      street =>"Академіка Ромоданова вул."
      aliases =>"(Пугачова вул.)"
   ...

У відповіді вулиці сортуються за абеткою.

4.2 Команди отримання списків географії

Ця група команд служить отримання повних списків географічних елементів із системи Plektan. Оскільки географія є досить рідко змінюваною інформацією, розробникам додатків корисно реалізувати кешування даних списків для прискорення відгуку сайту та зменшення навантаження на сервер API.
Для кожного елемента зі списків географії представлено два параметри - value (значення id - ідентифікатора елемента, який можна використовувати для пошукових запитів і при подачі оголошення) і caption (відображається відвідувачеві сайту значення, що надходить у локалізації, вказаній у запиті).

4.2.1 Команда [getDistricts]

Ця команда слугує для отримання списку районів міста.

Відповідь надходить у наступному форматі:

Array[10]
   2459 =>Array[3]					// направлення (група районів)
      value =>"Алексеевское направление"			// ідентифікатор district_id
      caption =>"Олексіївський напрямок"			// відображуване значення
      items =>Array[5]					// список районів
         2460 =>Array[2]					// район міста
            value =>"Алексеевка"				// идентифікатор district_id
            caption =>"Олексіївка"				// відображуване значення
         2461 =>Array[2]					// — - —
            value =>"Іванівка"
            caption =>"Іванівка"
		...
   ...
   2405 =>Array[3]					//  — - —
      value =>"Прилеглі до центру"
      caption =>"Прилеглі до центру"
      items =>Array[10]
         2682 =>Array[2]					// район міста
            value =>"Артема пос.."				// ідентифікатор district_id
            caption =>"Артема сел."				// відображуване значення
         2408 =>Array[2]
            value =>"Восстания площ."
            caption =>"Повстання площ."
		...
   ...

Перелік районів міста дворівневий. Райони згруповані до груп районів, тому структура районів міста — деревоподібна. Цифра, що стоїть перед кожною групою районів та районом (наприклад, 2405 =>Array[3] …), є ідентифікатором (id) даного елемента таблиці, що зберігає інформацію про вкладеності районів (дерево).

4.2.2 Команда [getSubway]

Ця команда слугує для отримання списку станцій метро міста.

Відповідь надходить у наступному форматі:

Array[3]
   0 =>Array[3]						// лінія метро
      value =>"Алексеевская линия"			// ідентифікатор subway_line
      caption =>"Олексіївська лінія"			// відображуване значення
      items =>Array[8]					// список станцій
         0 =>Array[2]						// станція метро
            value =>"23 Августа"				// ідентифікатор subway_station
            caption =>"23 серпня"				// відображуване значення
         1 =>Array[2]						// — - —
            value =>"Алексеевская"
            caption =>"Олексіївська"
		...
   ...
   2 =>Array[3]						// — - —
      value =>"Холодногорско-Заводская линия"
      caption =>"Холодногірсько-Заводська лінія"
      items =>Array[13]
         0 =>Array[2]						// станція метро
            value =>"Завод имени Малышева"			// ідентифікатор subway_station
            caption =>"Завод імені Малишева"			// відображуване значення
		...
         5 =>Array[2]
            value =>"Проспект Гагарина"
            caption =>"Проспект Гагаріна"
		...

На першому рівні приходить список ліній метрополітену міста. На другому рівні – список станцій даної лінії.

4.2.3 Команда [getSuburb]

Ця команда служить для отримання списку населених пунктів передмістя.

Відповідь надходить у наступному форматі:

Array[2]
   Харківський район =>Array[3]			// район області
      value =>"Харківський район"				// ідентифікатор region_id
      caption =>"Харківський район"			// відображуване значення
      items =>Array[58]					// список населених пунктів
         0 =>Array[2]						// населений пункт
            value =>"Олександрівка"				// ідентифікатор locality_id
            caption =>"Олександрівка"			// відображуване значення
         1 =>Array[2]						// — - —
            value =>"Артемівка"
            caption =>"Артемівка"
		...
   Дергачівський район =>Array[3]			// — - —
      value =>"Дергачівський район"
      caption =>"Дергачівський район"
      items =>Array[17]
         0 =>Array[2]						// населений пункт
            value =>"Березівське"				// ідентифікатор locality_id
            caption =>"Березівське"				// відображуване значення
         1 =>Array[2]
            value =>"Бермінводи"
            caption =>"Бермінводи"
		...

На першому рівні приходить перелік приміських районів області. На другому рівні – список населених пунктів цього району області.

4.2.4 Команда [getRegion]

Ця команда служить для отримання списку районів області (регіонів першого рівня країни).

Відповідь надходить у наступному форматі:

Array[1]
   Харківська область =>Array[3]			// область (регіон першого рівня)
      value =>"Харківська область"			// ідентифікатор region_id
      caption =>"Харківська область"		// відображуване значення
      items =>Array[27]					// список районів області
         0 =>Array[2]						// район області
            value =>"Балаклійський район"			// ідентифікатор region_id
            caption =>"Балаклійський район"		// відображуване значення
         1 =>Array[2]						// — - —
            value =>"Барвінківський район"
            caption =>"Барвінківський район"
		...

Область та райони області є регіонами в контексті системи Plektan та мають відношення вкладеності (дерево).

5 Секція [API_user]

5.1 Команда [getMasters]

Команда служить для отримання списку «Майстерів якості» - співробітників компанії, зареєстрованих у системі Plektan та відзначених як майстер якості.
Жодних додаткових параметрів ця команда не має.
Формат результату наступний:

Array[5]
   0 =>Array[7]
      user_id =>"80855"						// id співробітника
      name =>"Мирослава Анатоліївна"			// публічне ім’я
      greeting =>"Завжди рада допомогти!"			// девіз — короткий текст
      phones =>Array[2]						// телефони співробітника
         0 =>"+380 (50) 000-00-01"
         1 =>"+380 (57) 000-00-02"
      email =>"miroslava@domain.com"			// електронна адреса
      url_small =>"http://domain/p1.small.jpg"		// URL фото
      site_id =>""						// id персонального сайту
   1 =>Array[7]
      user_id =>"80842"						// id співробітника
      ...
   ...

Оскільки список майстрів якості є досить рідко змінюваною інформацією, розробникам додатків корисно реалізувати кешування цих даних для прискорення відгуку сайту та зменшення навантаження на сервер API.

5.2 Команда [sendMessage]

Команда служить для відправки відвідувачем сайту повідомлення (на email) співробітника компанії, зареєстрованого в системі Plektan.

У разі вдалого надсилання листа сервер поверне відповідь TRUE, невдалої - FALSE. Якщо буде передано неправильний user_id, сервер поверне рядок 'user not found'.
Для роботи команди потрібна активація її на стороні API Plektan. Для активації запитуюча компанія повинна надати параметри доступу до однієї зі своїх поштових скриньок за протоколом SMTP. З цього ящика надсилатимуться повідомлення-листи співробітникам компанії.

5.3 Команда [getPublicInfo]

Команда дозволяє отримати публічну інформацію про зареєстрованого у системі Plektan співробітника компанії. У команді обов'язковий один із параметрів: user_id або site_id.

Формат відповіді наступний:

Array[7]
   user_id =>"12574"						// id співробітника
   name =>"Оксана Василівна"					// публічне ім’я
   greeting =>"Завжди рада допомогти!"				// девіз — короткий текст
   phones =>Array[3]						// телефони співробітника
      0 =>"+380 (67) 000-00-01"
      1 =>"+380 (63) 000-00-02"
      2 =>"+380 (57) 000-00-03"
   email =>"oksana@domain.com"				// електронна адреса
   media =>Array[1]						// список фотографій
      0 =>Array[2]
         0 =>"В офісі"						// підпис до фото
         1 =>"http://domain/photo.jpg"			// URL фото
   about_self =>"10 років досвіду в сфері нерухомості"	// коротка інформація про себе

Ця команда буде корисною для отримання інформації про співробітника при реалізації функціоналу персональних сайтів агентів на сайті компанії.

6 Формат оголошень у відповідях API Plektan

6.1 Формат оголошень у пошуку

Поля оголошень, що надходять у відповідях сервера на пошукові запити.

Array[39]
   adid =>"SF-912-319"						// номер оголошення
   date_add =>"2019-01-29 14:18:17.020153+02"		// дата додавання оголошення
   date_mod =>"2013-07-04 10:49:37.153962+03"		// дата останньої модифікації
   deferred_to =>""						// дата, до якої відкладено 
   deal =>"Продам"						// тип угоди
   property =>"квартиру"					// тип нерухомості
   prop_kind =>"готельку"					// вид нерухомості
   deal.value =>"sell"						// тип угоди (значення)
   property.value =>"flat"					// — - —
   prop_kind.value =>"gostinka"				// — - —
   media =>Array[4]						// медіафайли
      src_small =>"http://domain/p1.small.jpg"		// URL фото
      src_middle =>"http://domain/p1.middle.jpg"	// — - —
      src_small_2 =>"http://domain/p2.small.jpg"
      src_middle_2 =>"http://domain/p2.middle.jpg"
   state =>"actual"						// стан оголошення (actual,
									// non_actual, deferred, closed)
   is_mls => ""							// true, якщо від партнера
   price =>Array[6]						// деталізація ціни
      value_m2 =>"≈3 206 ₴"				// за кв. метр
      value_are =>"≈320 622 ₴"			// за сотку (ділянки)
      value_obj =>"76 950 ₴"					// за об’єкт
      kind =>"per_object"					// тип основної ціни
      currency_id =>"UAH"					// валюта
      value =>"76 950 ₴"					// значення основної ціни
   base_price =>"81 000 ₴"					// початкова ціна
   discount =>"4 050 ₴"						// знижка (якщо є)
   zone =>"Житлова"						// зона (житлова, відпочинку, ...)
   red_line =>"1"							// червона лінія (1 або "")
   housing_class =>"економ"					// клас житла
   is_newbuilding =>""						// новобудова (1 или "")
   storey =>"6"							// поверх (номер чи підвал, 
									// цоколь, пентхаус)
   storeys =>"6"							// поверховість
   access_road =>"Асфальт"					// під'їзна дорога
   standard_planning =>"хрущовка"				// планування
   area_total =>"24"						// загальна площа, м²
   area_life =>"16"						// житлова площа, м²
   area_kitchen =>""						// площа кухні, м²
   area_lot =>""							// площа ділянки, сот
   room_count =>"1"						// кількість кімнат
   repair =>"косметичний ремонт"				// ремонт
   wall_material =>"цегла"					// матеріал стін
   water =>""							// вода
   gas =>"є"							// газ
   heating =>""							// опалення
   canalization =>""						// каналізація
   legal_information =>""					// юридична інформація
   locality =>"Харків"						// населений пункт
   district =>"22-лікарня, Нові доми"			// район міста
   street =>"Маршака вул."				// вулиця
   subway_station =>"Палац Спорту"			// станція метро
   buyer_not_pay =>"1"						// клієнт не сплачує (1 або "")

6.2 Поля оголошень в оголошенні детально (картці)

Стандартні поля об'яви, отримані в [view] секції [API_view], описані нижче. Набір полів є однаковим для всіх типів нерухомості. Поля, які не притаманні даному типу нерухомості (наприклад, кількість кімнат для ділянок) – приходять порожніми.

Array[98]
   adid =>"SF-912-319"						// номер оголошення
   advert_id =>"48682"						// id оголошення
   date_mod =>"2013-11-14 16:29:20.894844+02"		// дата останньої модифікації
   deal =>"Продам"						// тип угоди
   property =>"квартиру"					// тип нерухомості
   prop_kind =>"готельку"					// вид нерухомості
   deal.value =>"sell"						// тип угоди (значення)
   property.value =>"flat"					// — - —
   prop_kind.value =>"gostinka"				// — - —
   media =>Array[4]						// медіафайли
      0 =>Array[2]
         src =>"http://domain/p1.jpg"			// URL фото
         title =>"прихожая"					// підпис фото
      ...
      2 =>Array[2]
         src =>"http://domain/p3.jpg"
         title =>"кухня"
      src_small =>"http://domain/p1.small.jpg"		// URL основного фото
   price =>Array[6]						// деталізація ціни
      value_m2 =>"≈3 206 ₴"				// за кв. метр
      value_are =>"≈320 622 ₴"			// за сотку (ділянки)
      value_obj =>"76 950 ₴"					// за об’єкт
      kind =>"per_object"					// тип основної ціни
      currency_id =>"UAH"					// валюта
      value =>"76 950 ₴"					// значення основної ціни
   base_price =>"81 000 ₴"					// початкова ціна
   discount =>"4 050 ₴"						// знижка (якщо є)
   an_fee =>"100 $"						// комісія АН (для оренди —
									// оплата при вселенні)
   an_fee_preview =>""						// ціна огляду (оренда)
   ownership =>"приватна"					// власність
   legal_information =>"під заставою"				// юридична інформація
   purpose =>""							// цільове призначення (БТІ)
   inspection_possibility =>""					// можливість огляду
   advert_info =>""						// дод. інформація по оголошенню
   housestr =>"15/2 корп. Б"					// номер будинку
   orient =>"ЮСІ"							// орієнтир
   zone =>"Житлова"						// зона (житлова, відпочинку,   ...)
   red_line =>""							// червона лінія
   housing_class =>"економ"					// клас житла
   storeys =>"6"							// поверховість
   lift =>"пасажирський, грузовий"				// ліфти
   percentages =>""						// відсоток готовності (недобудова)
   deadline =>""							// термін здачі (недобудова)
   developer =>"Строй-инвест"					// будівельна компанія
   year_built =>"після 2000"					// рік побудови
   is_newbuilding =>"1"						// новобудова (1 или "")
   wall_material =>"цегла"					// матеріал стін
   floor_material =>"комбіновані"					// матеріал перекриттів
   roof =>""							// дах
   access_road =>""						// під’їзна дорога
   plot_covering =>""						// покриття ділянки
   additionaly_params =>""					// додаткові параметри (для
								// нежитлової — залізнич. гілка та ін.)
   standard_planning =>"сталінка"				// планування
   room_layout =>"роздільна"					// схема кімнат
   storey =>"6"							// поверх (номер чи підвал, 
									// цоколь, пентхаус)
   fasing =>""							// зовнішнє оздоблення
   ceiling_height =>"3"						// висота стелі, м
   area_total =>"24"						// загальна площа, м²
   area_life =>"16"						// житлова площа, м²
   area_kitchen =>"15"						// площа кухні, м²
   area_lot =>""							// площа ділянки, сот
   room_count =>"1"						// кількість кімнат
   bedroom_count =>"0"						// в т.ч. кількість спалень
   bathroom_count =>"1"						// кількість санвузлів
   balcony_count =>"1"						// кількість балконів
   room_explication =>"- Кухня: 15 м&sup2;<br/>		// деталізація по кімнатам
- Кімната: 20 м&sup2;<br/>
- Санвузол: 2 м&sup2;, душова кабіна, унітаз, біде, умивальник<br/>
- Балкон: 2 м&sup2;, засклений, утеплений<br/>
- Коридор: 3 м&sup2;"
   bathroom_equipment =>Array[2]				// сантехніка
      rating =>"добрий"						// стан
      values =>"імпортна"						// параметри
   tubing =>Array[2]						// труби
      rating =>"задовільний"				// — - —
      values =>"сталь"						// — - —
   floors =>Array[2]						// підлога
      rating =>"добрий"						// — - —
      values =>"паркет"						// — - —
   walls =>Array[2]						// стіни
      rating =>"добрий"
      values =>"шпалери, плитка на кухні, плитка у ванній"
   ceiling =>Array[2]						// стеля
      rating =>"добрий"
      values =>"штукатурка"
   convector =>Array[2]						// батареї опалення
      rating =>"добрий"
      values =>"алюміній"
   wires =>Array[2]						// проводка
      rating =>"добрий"
      values =>"алюміній"
   windows =>Array[2]						// вікна
      rating =>"задовільний"
      values =>"дерево"
   outer_doors =>Array[2]					// вхідні двері
      rating =>"добрий"
      values =>"броньовані"
   doors =>Array[2]						// міжкімнатні двері
      rating =>"добрий"
      values =>"дерево"
   repair =>"косметичний ремонт"				// ремонт
   repair_date =>"до року тому"				// коли зроблений ремонт
   water =>"центральна"					// вода
   gas =>"є"							// газ
   heating =>""							// опалення
   canalization =>""						// каналізація
   voltage =>""							// електрична напруга
   power =>""							// електрична потужність
   phone =>"одна лінія"						// телефон
   internet =>"локальна мережа"				// інтернет
   television =>"кабельне ТБ"				// телебачення
   meters =>"холодна вода, гаряча вода, газ"		// лічильники
   entrance =>"вхід з двору"				// під’їзд
   floor_heating =>""						// тепла підлога
   air_conditioning =>""					// кондиціонування повітря
   alarm =>"пожежна"						// сигналізація
   waterheater =>""						// водонагрівач
   water_purification =>""					// система очищення води
   household_appliances =>"телевізор, холодильник"	// побутова техніка
   additionaly =>"мусоропровід"				// додатковий благоустрій
   parking =>"гаражний кооператив (10 хв.)"		// парковка
   transport =>"метро - Масельского (5 хв. пішки)"		// громадський транспорт
   education =>"школа, дитсадок"				// навчальні заклади
   banking_services =>""					// банківські послуги
   consumer_services =>"аптека"				// побутовий сервіс
   relaxation_services =>"більярд, парк (сад)"		// релаксаційні послуги
   public_catering =>"кафе, ресторан"			// громадське харчування
   construction_yard =>""					// дворові будівлі (будинки)
									// рекламний текст
   promo_text =>"Продам готельку. Чистий поверх, кухня, служби."
   state =>"actual"						// стан оголошення (actual,
									// non_actual, deferred, closed)
   locality =>"Харків"						// населений пункт
   district =>"ХТЗ, Роганський напрямок"		// район міста
   street =>"Миру вул."					// вулиця
   subway_station =>"Масельського"				// станція метро
   buyer_not_pay =>""						// клієнт не сплачує (1 або "")
   users =>Array[1]					// список співробітників, які мають
      0 =>Array[7]						// відношення до оголошення
         user_id =>"835"					// id співробітника
         name =>"Аліна Миколаївна"				// ім’я співробітника
         greeting =>""						// привітання (девіз)
         phones =>Array[3]					// телефони співробітника
            0 =>"+380 (66) 000-00-01"
            1 =>"+380 (63) 000-00-02"
         email =>"alena@domain.com"				// електронна адреса
         url_small =>""						// URL фото співробітника
         site =>"http://alena.domain.com"			// якщо активовано  — 
								// адреса персонального сайту         status =>"offline"					// статус (offline, online)

Якщо у запиті картки оголошення в полі валюти передати масив валют, перший елемент масиву вважається основною валютою, а для інших елементів надходять два додаткові поля наступного формату:

    prices_list =>Array[2]					// список поточних цін
      0 =>Array[6]
         value_m2 =>"≈590 $"
         value_are =>"≈59 028 $"
         value_obj =>"8 500 $"
         kind =>"per_object"
         currency_id =>"USD"
         value =>"8 500 $"
      1 =>Array[6]
         value_m2 =>"≈460 €"
         value_are =>"≈46 042 €"
         value_obj =>"6 630 €"
         kind =>"per_object"
         currency_id =>"EUR"
         value =>"6 630 €"
   base_prices_list =>Array[2]				// список початкових цін
      0 =>"8 500 $"
      1 =>"6 630 €"

У випадку, якщо в налаштуваннях API для цієї компанії включена функція отримання списку схожих оголошень, у відповіді на запит картки оголошення надходить додатково поле зі списком оголошень наступного формату:

similar_adverts =>Array[1]
      0 =>Array[39]
         adid =>"SF-010-902"
         date_mod =>"2013-06-03 20:41:26.852807+03"
         deal =>"Продам"
         property =>"квартиру"
         prop_kind =>"готельку"
         deal.value =>"sell"
         property.value =>"flat"
         prop_kind.value =>"gostinka"
         media =>""
         price =>Array[6]
            value_m2 =>"≈5 400 ₴"
            value_are =>"≈540 003 ₴"
            value_obj =>"64 800 ₴"
            kind =>"per_object"
            currency_id =>"UAH"
            value =>"64 800 ₴"
         base_price =>"64 800 ₴"
         discount =>""
         zone =>""
         red_line =>""
         housing_class =>"економ"
         is_newbuilding =>""
         storey =>"6"
         storeys =>"6"
         access_road =>""
         standard_planning =>"нестандартне планування"
         area_total =>"12"
         area_life =>""
         area_kitchen =>""
         area_lot =>""
         room_count =>"1"
         repair =>"косметичний ремонт"
         wall_material =>""
         water =>""
         gas =>"немає"
         heating =>""
         canalization =>""
         promo_text =>""
         state =>"actual"
         legal_information =>""
         locality =>"Харків"
         district =>"ХТЗ, Роганський напрямок"
         street =>"Миру вул."
         subway_station =>""
         buyer_not_pay =>""

Формат і значення полів такі ж, як і в описаному вище оголошенні докладно.

7 Довідники

Довідники є поля з строго певним набором значень. Цей розділ містить довідники у форматі JSON. Латинськими літерами до двокрапки написані значення, після двокрапки — російське значення, що рекомендується.

7.1 Довідник property

Довідник Тип нерухомості:

(
	'flat': 'Квартиру',
	'house': 'Будинок',
	'commercial': 'Комерційну',
	'plot': 'Ділянку'
)

7.2 Довідник prop_kind

Довідник Вид нерухомості:

(
	'flat': (
		'isolated': "ізольовану",
		'apartments': "апартаменти",
		'penthouse': "пентхаус",
		'studio': "студію",
		'gostinka': "готельку",
		'another_sleeping': "підселення",
		'unfinished_new_build': "незданий новобуд"
	),
	'house': (
		'single': "цілий",
		'part': "частину",
		'town_house': "таунхаус",
		'palace': "особняк",
		'holiday_home': "дачний будинок",
		'unfinished': "недобуд",
	),
	'commercial': (
		'office': (
			'caption': "офісні приміщення",
			'items': (
				'office_in_house': "офіс у багатоквартирному будинку",
				'office_center': "офіс в офісному центрі",
				'office_free': "офісна будівля",
				'office_premise': "офісне приміщення"
			),
		),
		'trade': (
			'caption': "об'єкти торгівлі",
			'items': (
				'pavilion': "павільйон",
				'pharmacy': "аптека",
				'shop': "магазин",
				'supermarket': "супермаркет",
				'mart': "торгівельний центр",
				'trade_premise': "торгівельне приміщення"
			),
		),
		'public_catering': (
			'caption': "об'єкти громадського харчування",
			'items': (
				'restaurant': "ресторан",
				'cafe': "кафе",
				'bar': "бар",
				'pizzeria': "піцерію",
				'restaurant-fastfood': "ресторан фастфуд",
				'catering_object': "об'єкт харчування"
			),
		),
		'service': (
			'caption': "об'єкти сервісу",
			'items': (
				'dry_cleaners': "хімчистка",
				'beauty_parlor': "салон краси",
				'hairdressing_saloon': "перукарню",
				'dental_office': "стоматкабінет",
				'clinic': "клініку",
				'car_service': "автосервіс",
				'fitness_center': "фітнес центр",
				'service_object': "об'єкт сервісу",
			),
		),
		'culture_of_life': (
			'caption': "об'єкти культпобуту",
			'items': (
				'club': "клуб",
				'theatre': "театр",
				'cinema': "кінотеатр",
				'bowling': "боулінг",
				'night_club': "нічний клуб",
				'culture_object': "об'єкт культпобуту"
			),
		),
		'storehouse': "склад",
		'production_area': "виробниче приміщення",
		'industrial_complex': "промисловий комплекс",
		'garage': "гараж",
		'hotel': "готель",
		'hostel': "хостел",
		'agricultural object': "об'єкт сільгосп призначення",
		'other_infrastructure': "інший об'єкт",
		'unfinished_object': "недобудований об'єкт"
	),
	'plot': (
		'dilapidated_house': "зі старим будинком",
		'dacha': "дачний",
		'construction_residential': "під забудову житлової нерухомості",
		'construction_non_residential': "під забудову нежитлової нерухомості",
		'private_house_building': "під забудову приватного будинку",
		'agricultural_purposes': "сільгосп призначення",
		'island': "острів"
	)
)

Для комерційної нерухомості групуючі елементи (офісні приміщення, об'єкти торгівлі тощо) не можна використовувати для передачі в параметрах команд. Можна використовувати тільки кінцеві елементи (наприклад, окремий офіс, павільйон і т.д.).

7.3 Довідник repair

Довідник Ремонт:

(
	'without_repair': 'без ремонту',
	'no_internal_works': 'без внутрішніх робіт',
	'without_finishing': 'без оздоблювальних робіт',
	'cosmetic': 'косметичний ремонт',
	'partial': 'частковий ремонт',
	'major': 'капітальний ремонт',
	'evro': 'євроремонт',
	'architectural_design': 'авторський дизайн'
)

7.4 Довідник housing_class

Довідник Клас житла:

(
	'econom': 'економ',
	'business': 'бізнес',
	'elit': 'еліт',
)

7.5 Довідник pay_willingness

Довідник Готовність клієнта платити комісійні:

(
	'willing_to_pay': 'Готовий сплачувати комісійні',
	'not_know_willing_to_pay': 'Не вирішив щодо комісійних',
	'not_willing_to_pay': 'Не готовий сплачувати комісійні',
)

7.6 Довідник wall_material

Довідник Матеріал стін:

(
	'panel': 'панель',
	'brick': 'цегла',
	'gas_block': 'газоблок',
	'cinder_block': 'шлакоблок',
	'monolit_carcas': 'моноліто-каркас',
	'foam_concrete': 'пінобетон',
	'keramzit_concrete': 'керамзітобетон',
	'poroterm': 'поротерм',
	'rakushnik_brick': 'ракушняк-цегла',
	'wood_brick': 'дерево-цегла',
	'wood': 'дерево'
)

7 Партнерська кнопка

На кожній сторінці сайту, які використовують API системи Plektan, потрібно розмістити партнерську кнопку. Переважне місце розміщення - підвал сайту (footer).
Код партнерської кнопки:

<a href="https://plektan.com/" title="plektan.com" target=_blank>
<script>
var plektan = {src:'//plektan.com/img/btn/work-with-plektan'};
if (document.documentElement.lang === "ru") (plektan.src += "-ru.png") && (plektan.alt = "Ми працюємо з PLEKTAN CRM");
else (plektan.src += "-uk.png") && (plektan.alt = "Ми працюємо з PLEKTAN CRM");
document.write('<img style="border:0" alt="' + plektan.alt + '" src="' + plektan.src + '">');
</script>
</a>