API | FLATRIS

Авторизація через API

Дані для авторизації chess_api_login та chess_api_key слід надсилати в кожному запиті.

Дані для авторизації

Список приміщень

Метод отримання списку квартир з можливістю фільтрації. У відповідь ви отримаєте масив JSON. Ліміт - 30 запитів за 30 секунд.

URL методу

GET https://flatris.com.ua/api/v1/flats

Виконати запит

ID квартири в базі FLATRIS, напр. 1001

Параметр	Тип	Опис
id	int
id_custom	string	ID квартири у таблиці Google Sheets, напр. `522`
gproject_id	int	ID об'єкта, наприклад. `333`
gproject	string	Назва об'єкта, наприклад. `ЖК Тестовий`
building_id	int	ID вдома, напр. `223`
building	string	Назва будинку напр. `1`
section_id	int	ID секції, напр. `555`
section	string	Назва секції, напр. `5`
rooms	int	Кількість кімнат, напр. `2`
crm_lead_id	int	ID ліда в amoCRM, напр. `24585`

Приклад запиту

GET https://flatris.com.ua/api/v1/flats?building_id=552&rooms=3&chess_api_login=login&chess_api_key=key

Приклад відповіді

{"data":{"message":"Запрос выполнен успешно!","flats":[{"id":"8815","id_custom":"2","number":"3","property_type":"flat","discount_price_m2":"16200","discount_price":"891000","price_m2":"16200","price":"891000","discount_end_date":"0000-00-00 00:00:00","comment":"","crm_lead_ids":"15155,15156","floor":"1","floor_id":"1344","type":"1а","plan_id":"2058","square_total":"55","square_live":"19","img":"https://flatris.com.ua/assets/uploads/71/plans/img-uc","img_3d":null,"rooms":"1","levels":"1","balconies":"0","loggias":"0","square_balconies":"10.5","square_loggias":"80.5","bathrooms_combined":"0","bathrooms_separate":"0","section":"1","section_id":"124","building":"107","building_id":"72","queue":"3","gproject":"ЖК Тестовый","gproject_id":"113","currency":"UAH","status":"Резерв","status_alias":"reserved","status_id":"3"}]}}

Список заявок

Метод отримання списку заявок. У відповідь ви отримаєте масив JSON. Ліміт - 30 запитів за 30 секунд.

URL метода

GET https://flatris.com.ua/api/v1/requests

Виконати запит

Параметр	Тип	Опис
id	int	ID заявки, напр. `999`
limit	int	Ліміт, напр. `10`
offset	int	Зміщення напр. `0`

Приклад запиту

GET https://flatris.com.ua/api/v1/requests?chess_api_login=login&chess_api_key=key

Приклад відповіді

{"data":{"message":"Запрос выполнен успешно!","requests":[{"id":"8360","createdon_timestamp":"1614170988","contact_name":"eee","contact_email":"","contact_phone":"33333","page":"https://flatris.com.ua/api/chess/?cid=QJXPgWMdhaxpjkzZ","text":"","ip":"61.216.44.106","host":"hostname.com","referer":"","gcid":"1893783632.1545655814","referer_gcid":"","utm_source":null,"utm_medium":null,"utm_term":null,"utm_content":null,"utm_campaign":null,"requested_item":{"id": 5488, "gproject_id": 86, "id_custom": "999", "number": "6a", "property_type": "flat", "discount": 10, "discount_price_m2": 9000, "discount_price": 385830, "price_m2": 10000, "price": 428700, "comment": "тестовый коммент 2", "condition": null, "floor": "2", "type": "42,87", "square_total": 42.87, "square_live": 20.1, "square_kitchen": 0, "img": "", "img_3d": "", "rooms": 1, "levels": 1, "balconies": 0, "loggias": 0, "square_balconies": 0, "square_loggias": 0, "bathrooms_combined": 0, "bathrooms_separate": 0, "bathrooms_count": 0, "section": "", "building": "1", "queue": "I", "gproject": "ЖК Благород DEMO", "currency": "UAH", "status": "Свободно", "status_alias": "free", "status_id": "1"}}]}}

Список усіх сутностей

Метод отримання списку сутностей з можливістю фільтрації по gproject_id. У відповідь ви отримаєте масив JSON. Ліміт - 30 запитів за 30 секунд.

URL методу

GET https://flatris.com.ua/api/v1/data

Параметр	Тип	Опис
gproject_id	int	ID об'єкта, наприклад. `333`
entities	string	Назва сутності через кому, напр. `gprojects,buildings,sections,flats,floorplans,plans_floorplans,floors,flats_floors,gallery_albums_objects,gallery_items`

Приклад запиту

GET https://flatris.com.ua/api/v1/data?entities=flats,floors,flats_floors,floorplans,plans_floorplans&gproject_id=1112&chess_api_login=login&chess_api_key=key

Приклад відповіді

{"data":{"flats":[{"id":"195230","id_custom":"1","number":"1","row_index":"1","property_type":"flat","deal_status":"primary","discount":"5","discount_price_m2":"15200","discount_price":"1124800","price_m2":"16000","price":"1184000","discount_end_date":"2019-01-28 00:00:00","comment":null,"first_payment":"0","monthly_payment":"0","condition":null,"credit_term":null,"credit_rate":"0","credit_price":"0","have_terrace":null,"dressing_room":null,"laundry_room":null,"panoramic_windows":null,"zenith_window":null,"crm_lead_ids":null,"crm_leads_json":null,"floor":"1","floor_id":"32734","type":"1A","plan_id":"104864","square_total":"74","square_live":"39.85","square_kitchen":"15.5","img":null,"img_3d":null,"rooms":"1","levels":"1","balconies":"1","loggias":"2","square_balconies":"0","square_loggias":"0","bathrooms_combined":"0","bathrooms_separate":"1","bathrooms_count":"0","section":"1","section_id":"4345","building":"2","building_id":"2321","queue":"1","gproject":"ЖК тест","gproject_id":"1127","currency":"USD","ga_id":null,"webchess":"","status":"Свободно","status_alias":"free","status_id":"2"}],"message":"Запрос выполнен успешно!"}}

Оновлення статусів та цін

Метод для оновлення статусів та цін для приміщень. У відповідь ви отримаєте масив JSON. Ліміт - 30 запитів за 30 секунд.

Для того, щоб значення цін оновлювалися в Google Sheets, слід НЕ використовувати формули в комірках, які оновлюєте. Комірки, які містять формули, ігноруються при оновленні.

URL методу

POST https://flatris.com.ua/api/v1/flats/update

Параметр	Тип	Опис
products	array	Масив виду `[ ['id'=> 3898, 'status'=>'Вільно'], ['id'=> 3899, 'status'=>'Вільно', 'price'=>200300 , 'price_m2'=>900, 'discount_price'=>180270, 'discount_price_m2'=>810, 'discount'=>10] ]`, де id - ID приміщення в базі FLATRIS, status - статус приміщення (Вільно, Резерв, Продано, Не у продажу), price - вартість, price_m2 - вартість м², discount_price - вартість зі знижкою, discount_price_m2 - вартість м² зі знижкою, discount - знижка у %
chess_api_login	string	Логін FLATRIS
chess_api_key	string	Ключ API FLATRIS

Приклад запиту

POST URL https://flatris.com.ua/api/v1/flats/update

POST BODY chess_api_login=login&chess_api_key=key&products[0][id]=3898&products[0][status]=Свободно&products[1][id]=3899&products[1][status]=Свободно&products[1][price]=200300

Приклад відповіді

{"data":{"message":"Данные успешно обновлены!","affected_ids":[3898, 3899]}}