Aktuální poloha:

Je to Vaše lokalita? Ne, změnit polohu

Bigle XML-RPC API

Pro používání API je potřeba se na bigle.cz zaregistrovat, pak vybrat v profilu Změnit programový klíč, kde
obdržíte ID uživatele a budete moci nastavit Programový klíč a API klíč.

Adresa serveru

https://www.bigle.cz/api/v1/xml-rpc

Autorizacní metody

Získání řetezce zvaného sessionId

Získání řetezce zvaného sessionId, který je použit pro hashování hesla

Dotaz

Metoda - getHash

Název	Typ	Popis	Povinný
client_id	int	Cislo makléře	+

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 453 - nesprávný formát čísla makléře 461 - makler nenalezen
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { sessionId: identifikace spojeni, }

Potvrzení přihlášení

Metoda login potvrdí session jako autorizovanou. V kladném případe se oveří, že výpocet nového session_id odpovídá ocekávání na strane serveru

Dotaz

Metoda - login

Název

Typ

Popis

Povinný

session_id

string

Postup výpoctu nového session_id:

fixedPart = session_id[0:48]

varPart = md5(session_id + md5(password) + software_key)

session_id = fixedPart + varPart

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni
statusMessage	string	Slovni popis statusu
output	array	Žádná data

Odhlášen

Odhlášení

Dotaz

Metoda - logout

Název	Typ	Popis	Povinný
session_id	string	ID relace	+

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK
statusMessage	string	Slovni popis statusu
output	array	Žádná data

Inzerátů

Výpis inzerátů

Výpis všech inzerátů přihlášené realitní kanceláře

Dotaz

Metoda - listAdvert

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo maklere

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { advert_id: cislo inzeratu, advert_rkid: interni cislo, advert_url: odkaz na detail inzeratu, advert_type: druh inzeratu (byty, domy), published: 1 - zverejneny, 0 - nezverejneny }

Přidání inzerátu

Dotaz

Metoda - addAdvert

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
advert	struct	Údaje o inzeratu	+

Advert struct

Název	Typ	Popis	Povinný
advert_function	int	Typ 1 - Prodej 2 - Pronájem	+
advert_price	double	Cena	+
advert_price_currency	int	Mena 1 - Kc 2 - USD 3 - EUR	+
advert_type	int	Kategorie 1 - Byt 2 - Dům 3 - Pozemky 4 - Komercní 5 - Ostatní	+
description	string	Popis	+
advert_id	int	ID inzeratu u bigle	pokud zadáno, advert_rkid je prázdné
advert_rkid	string	Interni cislo inzeratu	pokud zadáno, advert_id je prázdné
advert_room_count	int	Velikost (jen pro dům) 1 - 1 pokoj 2 - 2 pokoje 3 - 3 pokoje 4 - 4 pokoje 5 - 5 pokoje 6 - 6 a více pokojů	+ (pro domy)
advert_subtype	int	Podkategorie Pro byty 2 - 1+kk 3 - 1+1 4 - 2+kk 5 - 2+1 6 - 3+kk 7 - 3+1 8 - 4+kk 9 - 4+1 10 - 5+kk 11 - 5+1 12 - 6 a více Pro domy 33 - Chata 37 - Rodinný 39 - Vila 43 - Chalupa Pro pozemky 18 - Komercní 19 - Bydlení 20 - Pole 21 - Lesy 22 - Louky 23 - Zahrady 24 - Ostatní 46 - Rybníky 48 - Sady/vinice Pro komercní 25 - Kanceláře 26 - Sklady 27 - Výroba 28 - Obchodní prostory 30 - Restaurace 32 - Ostatní 38 - Cinžovní dům Pro ostatní 34 - Garáž	+
balcony	bool	Balkón
building_condition	int	Stav objektu 1 - Velmi dobrý 2 - Dobrý 3 - Špatný 4 - Ve výstavbě 5 - Projekt 6 - Novostavba 7 - K demolici 8 - Před rekonstrukcí 9 - Po rekonstrukci
building_type	int	Stavba 1 - Dřevená 2 - Cihlová 3 - Kamenná 4 - Montovaná 5 - Panelová 6 - Skeletová 7 - Smíšená
cellar	bool	Sklep
estate_area	double	Plocha pozemku
floor_number	int	Patro
garage	bool	Garáž
locality_city	string	Mesto	+
locality_citypart	string	Mestská část
locality_street	string	Ulice
locality_co	string	Číslo orientační
locality_cp	string	Číslo popisné
locality_latitude	double	Zemepisná šířka
locality_longitude	double	Zemepisná délka
loggia	bool	Lodžie
ownership	int	Vlastnictví 1 - Osobní 2 - Družstevní
parking_lots	bool	Parkování
seller_id	int	ID maklere u bigle	pokud zadáno, seller_rkid je prázdné
seller_rkid	string	Interni cislo maklere	pokud zadáno, seller_id je prázdné
terrace	bool	Terasa
usable_area	double	Užitná plocha
balcony_area	double	Plocha balkónu
building_area	double	Plocha zastavená
ceiling_height	double	Výška stropu
cellar_area	double	Plocha sklepu
easy_access	int	Bezbariérový 1 - Ano 2 - Ne
elevator	int	Výtah 1 - Ano 2 - Ne
energy_efficiency_rating	int	Energetická nárocnost 1 - A (mimořádne úsporná) 2 - B (velmi úsporná) 3 - C (úsporná) 4 - D (méne úsporná) 5 - E (nehospodárná) 6 - F (velmi nehospodárná) 7 - G (mimořádne nehospodárná)
flat_class	int	Typ bytu 1 - Mezonet 2 - Loft 3 - Podkrovní
floor_area	double	Plocha podlahová
floors	int	Podlaží pocet
garage_count	int	Pocet garáží
garden_area	double	Plocha zahrady
gas	int	Plyn 1 - Individuální 2 - Plynovod 3 - Jiné
gully	int	Odpad 1 - Veřejná kanalizace 2 - ČOV pro celý objekt 3 - Septik 4 - Jímka
heating	int	Topení 1 - Lokální plynové 2 - Lokální tuhá paliva 3 - Lokální elektrické 4 - Ústřední plynové 5 - Ústřední tuhá paliva 6 - Ústřední elektrické 7 - Ústřední dálkové 8 - Jiné
loggia_area	double	Plocha lodžie
offices_area	double	Plocha kanceláří
parking	int	Míst k parkování
production_area	double	Plocha výrobní
reconstruction_year	int	Rok rekonstrukce
shop_area	double	Obchodní plocha
store_area	double	Plocha skladů
telecommunication	int[]	Telekomunikace 1 - Telefon 2 - Internet 3 - Satelit 4 - Kabelová televize
terrace_area	double	Plocha terasy
water	int	Voda 1 - Místní zdroj 2 - Dálkový vodovod

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře 461 - makler nenalezen
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { advert_id: cislo inzeratu, advert_url: odkaz na detail inzeratu }

Vymazání inzerátu

Vymazání inzerátu makléře

Dotaz

Metoda - delAdvert

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo inzeratu	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Žádná data

Vložení fotografie k inzerátu

Vložení fotografie k již uloženému inzerátu

Dotaz

Metoda - addPhoto

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo inzeratu	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné
photo	struct	Údaje o obrázku	+

Photo struct

Název	Typ	Popis	Povinný
data	binary	Vlastní obrázek	+
main	int	Hlavní fotka 1 - hlavní 2 - ostatní	+
alt	string	Popisek obrázku

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { photo_id: cislo fotografie }

Vymazání fotografie

Dotaz

Metoda - delPhoto

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo fotografie	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla fotografie
statusMessage	string	Slovni popis statusu
output	array	Žádná data

Výpis fotografie

Výpis fotografie existujícího inzerátu

Dotaz

Metoda - listPhoto

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo inzeratu	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { photo_id: cislo fotografie, photo_rkid: interni cislo, main: hlavni fotografie (1 - ano, 0 - ne), }

Výpis statistiky inzerátu

Dotaz

Metoda - listStat

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo inzeratu	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { advert_id: cislo inzeratu, total_views: celkova navstevnost, total_price: cena }

Výpis denní statistiky inzerátu

Dotaz

Metoda - listDailyStat

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo inzeratu	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { date: datum dne, views: pocet shlednuti, price: cena }

Výpis statistiky všech inzerátů

Výpis statistiky všech inzerátů daného klienta za konkrétní den

Dotaz

Metoda - listAllDailyStat

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
date	date	Datum (dd.mm.yyyy)	+

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { advert_id: cislo inzeratu, views: navstevnost, advert_price: cena }

Makléř

Výpis makléřů

Výpis všech makléřů vytvořených uživatelem se zadaným klíčem

Dotaz

Metoda - listSeller

Název	Typ	Popis	Povinný
session_id	string	ID relace	+

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { seller_id: cislo maklere, seller_rkid: interni cislo, client_name: jmeno a prijmeni, client_login: login (email) maklere, photo: 1 - ano, 0 - ne }

Přidání nového makléře

Dotaz

Metoda - addSeller

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo maklere	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné
seller	struct	Údaje o makleru	+

Seller struct

Název	Typ	Popis	Povinný
client_login	string	Email pro login	+
client_name	string	Jmeno a prijmeni	+
contact_phone	string	Telefon
contact_email	string	Email	+
client_ic	int	IČO makléře	+
client_is_employee	bool	Makléř je zaměstnanec
broker_specialization	int[]	Specializace makléře 0 - Prodej 1 - Pronájem 2 - Správa nemovitostí 3 - Výkup 4 - Oceňování nemovitostí 5 - Daňové poradenství 6 - Prodej nových budov 7 - Komerční nemovitosti 8 - Pozemky 9 - Investice do nemovitostí 10 - Ostatní
makler_note	string	Poznámka
photo	binary	Obrázek makléře

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { seller_id: seller id }

Vymazání makléře

Vymazání existujícího makléře

Dotaz

Metoda - delSeller

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo maklere	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Žádná data

Výpis statistik makléře

Výpis denních statistik inzerátů jednoho makléře. Cas je zadán uzavřeným intervalem

Dotaz

Metoda - listSellerStat

Název	Typ	Popis	Povinný
session_id	string	ID relace	+
id	int	Cislo maklere	pokud zadáno, rkid je prázdné
rkid	string	Interni cislo	pokud zadáno, id je prázdné
from	date	Od data (dd.mm.yyyy)	+
till	date	K datu (dd.mm.yyyy)	+

Odpověď

Název	Typ	Popis
status	int	Status 200 - OK 407 - neplatne prihlaseni 452 - nekompletni data 453 - nesprávný formát čísla makléře
statusMessage	string	Slovni popis statusu
output	array	Pole objektů { date: datum dne, advert_count: pocet inzeratu, views: pocet shlednuti inzeratu }