Pobieranie ofert rynku pierwotnego z serwisu

URL

http://ofertymieszkan.pl/api/oferty/pierwotny.xml?key=TUTAJNALEZYWSTAWICKLUCZAPI123

Struktura dokumentu XML

<?xml version="1.0" encoding="UTF-8"?>
    <dane data-aktualizacji="2010-09-26 00:00:00">
      <inwestycje> 
        <!-- Tutaj znajduje się lista inwestycji  -->
        <inwestycja typ="typ inwestycji"> 
          <!-- Treść przykładowej inwestycji  -->
          <oferty>
            <!-- Tutaj znajduje się lista mieszkań  -->
            <oferta>
              <!-- Tutaj znajduje treść mieszkania  -->
            </oferta>
          </oferty>
        </inwestycja>
      </inwestycje>
    </dane>

Możliwe typy inwestycji:

<inwestycja typ="mieszkanie"></inwestycja>

Atrybuty podstawowe

Takie atrybuty, choć nie zawsze są obowiązkowe do podania, posiadają swoje osobne znaczniki i opisują podstawowe cechy danej oferty. Wytłuszczone atrybuty są obecne w każdej ofercie.

<url> — wartość kluczowa przy współpracy partnerskiej, określa adres URL, pod którym można znaleźć opisywaną inwestycję w serwisie OfertyMieszkań.pl
<id> — unikalny string w formacie om-liczba, jednoznacznie identyfikujący rekord w serwisie OfertyMieszkań.pl, niezależnie od typu transakcji, rodzaju nieruchomości czy rynku
<nazwa> — nazwa inwestycji
<firma> — nazwa dewelopera, który zbudował daną inwestycję
<data_dodania> — data dodania oferty do systemu
<data_aktualizacji> — data ostatniej zmiany rekordu, ta wartość jednoznacznie określa, czy rekord się zmienił, dlatego jeśli ostatnio pobrana przez Ciebie data aktualizacji jest różna od obecnej, należy zaktualizować ofertę w Twojej bazie
<dada_oddania> — przewidywalny termin oddania inwestycji do użytki

<wojewodztwo> — nazwa województwa; poniżej przedstawiono wszystkie możliwe wartości

<wojewodztwo text-id="dolnoslaskie">dolnośląskie</wojewodztwo>
<wojewodztwo text-id="kujawsko-pomorskie">kujawsko-pomorskie</wojewodztwo>
<wojewodztwo text-id="lubelskie">lubelskie</wojewodztwo>
<wojewodztwo text-id="lubuskie">lubuskie</wojewodztwo>
<wojewodztwo text-id="lodzkie">łódzkie</wojewodztwo>
<wojewodztwo text-id="mazowieckie">mazowieckie</wojewodztwo>
<wojewodztwo text-id="malopolskie">małopolskie</wojewodztwo>
<wojewodztwo text-id="opolskie">opolskie</wojewodztwo>
<wojewodztwo text-id="podkarpackie">podkarpackie</wojewodztwo>
<wojewodztwo text-id="podlaskie">podlaskie</wojewodztwo>
<wojewodztwo text-id="pomorskie">pomorskie</wojewodztwo>
<wojewodztwo text-id="slaskie">śląskie</wojewodztwo>
<wojewodztwo text-id="swietokrzyskie">świętokrzyskie</wojewodztwo>
<wojewodztwo text-id="warminsko-mazurskie">warmińsko-mazurskie</wojewodztwo>
<wojewodztwo text-id="wielkopolskie">wielkopolskie</wojewodztwo>
<wojewodztwo text-id="zachodniopomorskie">zachodniopomorskie</wojewodztwo>

<miasto> — nazwa miejscowości, przyjmująca postać dowolnego stringa
<dzielnica> — nazwa dzielnicy, przyjmująca postać dowolnego stringa
<kontakt_osoba> — osoba lub organizacja, z którą można się skontaktować w sprawie inwestycji
<kontakt_email> — adres e-mail osoby/instytucji kontaktowej
<kontakt_telefon> — numer telefonu osoby/instytucji kontaktowej
<geo_szer> — dokładna szerokość geograficzna lokalu, występuje jako float
<geo_dl> — dokładna długość geograficzna lokalu, występuje jako float
<opis> — tekstowy opis inwestycji, występujący wewnątrz sekcji CDATA
<opis> — tekstowy opis okolicy, występujący wewnątrz sekcji CDATA
<zdjecie> — bezwzględny adres URL, z którego można pobrać oryginał głównego zdjęcia oferty; to zdjęcie należy wyświetlać jako podstawowe zdjęcie w wynikach wyszukiwania serwisu partnerskiego
<calkowita_liczba_ofert> — całkowita liczba ofert w inwestycji

<forma_wlasnosci> — tekst opisujący formę własności mieszkań w inwestycji

<forma_wlasnosci>hipoteczne</forma_wlasnosci>
<forma_wlasnosci>spółdzielcze własnościowe</forma_wlasnosci>
<forma_wlasnosci>spółdzielcze lokatorskie</forma_wlasnosci>

<liczba_pieter> — tekst opisujący liczbę pięter; pole jest w formie testwej, ponieważ dana inwestycja może zawierać kilka budynków, wówczas tekst opisuje liczbę pięter w każdym z budynków; forma wartości jest dowolna
<podziemne_kondygnacje> — tekst opisujący występującą w inwestycji podziemną kondygnację, np. garaż
<wykonczenie> — opis wykończenia budowlanego mieszkań w inwestycji
<wykonczenie> — opis wykończenia budowlanego mieszkań w inwestycji
<wycena_powierzchni> — tekst informujący o sposobie kalkulacji cen powierzchni przynależnych: np. czy za garaż płaci się osobno, czy jego cena jest wliczona w cenę mieszkania
<harmonogram_platnosci> — opis wielkości rat i ich terminu spłaty
<logo_inwestycji> — kreacja graficzna, najczęściej logo, która symbolizuje inwestycję
<logo_firmy> — logo dewelopera

Użycie znaczników logo_inwestycji oraz logo_firmy wygląda podobnie, przedstawione jest na przykładzie:

<logo_inwestycji miniaturka="http://ofertymieszkan.pl/system/logos/1/detail/inw.jpg">
  http://ofertymieszkan.pl/system/logos/1/detail/inw.pdf</logo_inwestycji>
<logo_firmy miniaturka="http://ofertymieszkan.pl/system/logos/8/detail/logo.jpg">
  http://ofertymieszkan.pl/system/logos/8/original/logo.pdf</logo_firmy>

UWAGA: Atrybut miniaturka zawiera adres do obrazka pomniejszonego w formacie JPEG. Powinien być stosowany tylko wówczas, gdy nie posiadasz możliwości samodzielnego generowania miniatur i odczytywania innych niż JPEG formatów. W każdym innym przypadku zalecamy korzystanie z samej wartości znacznika — należy się jednak przygotować na to, że logo może być podane w formacie wektorowym, np. PDF, SVG lub EPS lub jako bitmapa bardzo wysokiej rozdzielczości. Do generowania miniatur i odczytu formatów wektorowych polecamy używanie ImageMagick lub podobnej biblioteki dostępnej jako open source.

Dodatkowe zdjęcia

Oferta może zawierać dowolną liczbę zdjęć, występujących w dowolnej kolejności. Pobranie dodatkowych zdjęć jest opcjonalne, jednak komplet zdjęć zwiększa atrakcyjność ogłoszenia.

  <!-- Poniżej znajduje się główne zdjęcie -->
  <zdjecie>http://ofertymieszkan.pl/photos/000/001/original/1248_1.jpg</zdjecie> 
  <!-- Poniżej znajdują się zdjęcia dodatkowe -->
  <zdjecia> 
    <zdjecie>http://ofertymieszkan.pl/files/000/003/original/zdj2.jpg</zdjecie> 
    <zdjecie>http://ofertymieszkan.pl/files/000/004/original/zdj5.jpg</zdjecie> 
  </zdjecia>

Ukrywanie ceny

Niekiedy deweloperzy nie życzą sobie, by serwis pokazywał ceny ofert. Wówczas w polu cena oraz cena_za_metr pokazujemy tekst cena u dewelopera. Przygotuj się na obsługę tego typu ofert.

Dodatki do inwestycji

Inwestycja może zawierać dodatkowe informacje o atrakcyjnych cechach osiedla, np. obecność siłowni lub podłączenie Internetu. Dodatki zgrupowane są wewnątrz znacznika <dodatki>, a konkretne wartości tekstowe znajdują się wewnątrz znacznika <dodatek>. Poniżej przedstawione jest zestawienie wszystkich możliwych dodatków:

<dodatki>
  <dodatek>basen</dodatek>
  <dodatek>fitness club</dodatek>
  <dodatek>internet</dodatek>
  <dodatek>ochrona 24h</dodatek>
  <dodatek>ogrody na dachach</dodatek>
  <dodatek>patio</dodatek>
  <dodatek>plac zabaw</dodatek>
  <dodatek>recepcja</dodatek>
  <dodatek>siłownia</dodatek>
  <dodatek>telefon</dodatek>
  <dodatek>teren ogrodzony</dodatek>
  <dodatek>teren strzeżony</dodatek>
  <dodatek>tv kablowa</dodatek>
  <dodatek>usługi w budynku</dodatek>
  <dodatek>videofon</dodatek>
  <dodatek>winda</dodatek>
  <dodatek>własna kotłownia</dodatek>
  <dodatek>podjazd dla niepełnosprawnych</dodatek>
  <dodatek>wentylacja mechaniczna</dodatek>
  <dodatek>całodobowy monitoring</dodatek>
  <dodatek>drewniane okna</dodatek>
  <dodatek>klimatyzacja</dodatek>
  <dodatek>sauna</dodatek>
  <dodatek>jaccuzi</dodatek>
  <dodatek>basen</dodatek>
  <dodatek>odnowa biologiczna</dodatek>
  <dodatek>punkt widokowy</dodatek>
  <dodatek>ogród letni</dodatek>
  <dodatek>salon masażu</dodatek>
  <dodatek>komora lodowa</dodatek>
  <dodatek>sala fitness</dodatek>
  <dodatek>solarium</dodatek>
  <dodatek>restauracja</dodatek>
  <dodatek>sala konferencyjna</dodatek>
  <dodatek>SPA</dodatek>
</dodatki>

Mieszkania w inwestycji

Inwestycja musi zawierać co najmniej jedno mieszkanie/dom. Mieszkania znajdują się wewnątrz znacznika <oferty>, każda z nich jest otoczona tagiem <oferta>. Każde mieszkanie zawiera sztywno określone atrybuty (ponownie, obowiązkowe - zawsze wypełnione - atrybuty oznaczono boldem):

<id> — unikalny string w formacie om-liczba-liczba, jednoznacznie identyfikujący rekord w serwisie OfertyMieszkań.pl, niezależnie od tego, w jakiej inwestycji się znajduje
<url> — wartość kluczowa przy współpracy partnerskiej, określa adres URL, pod którym można znaleźć opisywane mieszkanie w serwisie OfertyMieszkań.pl
<status> — przyjmuje 0 dla mieszkania już sprzedanego (lub niedostępnego w celach handlowych), lub 1 dla mieszkania dostępnego; zaleca się nie wyświetlanie mieszkań o statusie równym 0
<nazwa> — numer indentyfikacyjny mieszkania nadany przez dewelopera
<cena> — cena mieszkania
<cena_za_metr> — cena za metr mieszkania
<powierzchnia> — powierzchnia mieszkania
<rzut> — bezwzględny adres URL z rzutem mieszkania, może występować jako PDF
<wysokosc> — wysokość netto mieszkania
<liczba_pokoi> — liczba pokoi w mieszkaniu
<pietro> — piętro na którym występuje mieszkanie
<rodzaj_garazu> — tekst określający rodzaj garażu
<cena_garazu> — cena garażu
<rodzaj_powierzchni_dodatkowej> — tekst określający rodzajh powierzchni dodatkowej
<cena_powierzchni_dodatkowej> — cena powierzchni dodatkowej
<metraz_powierzchni_dodatkowej> — metraż powierzchni dodatkowej

Przykładowy eksport z jedną inwestycją

<?xml version="1.0" encoding="UTF-8"?>
<dane data-aktualizacji="2010-10-14 00:00:00">
  <inwestycje> 
    <inwestycja typ="mieszkania"> 
      <id>om-930</id> 
      <nazwa>Apartamenty Testowe</nazwa>
      <firma>Firma Sp. z o.o.</firma> 
      <logo_inwestycji miniaturka="http://ofertymieszkan.pl/system/logos/1/detail/inw.jpg">
  http://ofertymieszkan.pl/system/logos/1/detail/inw.pdf</logo_inwestycji>
      <logo_firmy miniaturka="http://ofertymieszkan.pl/system/logos/8/detail/logo.jpg">
  http://ofertymieszkan.pl/system/logos/8/original/logo.pdf</logo_firmy>
      <data_dodania>2010-09-17 13:52:47</data_dodania> 
      <data_aktualizacji>2010-09-19 16:22:57</data_aktualizacji> 
      <wojewodztwo text-id="mazowieckie">mazowieckie</wojewodztwo> 
      <miasto>Warszawa</miasto> 
      <dzielnica>Wilanów</dzielnica>
      <ulica>al. Rzeczypospolitej</ulica>
      <url>http://ofertymieszkan.pl/nieruchomosci/nieruchomosci/930</url> 
      <kontakt_osoba>Biuro Sprzedaży </kontakt_osoba> 
      <kontakt_email>test@email.pl</kontakt_email> 
      <kontakt_telefon>22 428 32 22, 22 428 38 22</kontakt_telefon> 
      <geo_szer>52.160744</geo_szer> 
      <geo_dl>21.0759759</geo_dl> 
      <data_oddania>Grudzień 2010</data_oddania>
      <opis><![CDATA[Opis...]]></opis>
      <okolica><![CDATA[Okolica...]]></okolica>
      <calkowita_liczba_ofert>136</calkowita_liczba_ofert>
      <ukryj_cene>tak</ukryj_cene>
      <forma_wlasnosci>hipoteczne</forma_wlasnosci>
      <liczba_pieter>5</liczba_pieter>
      <podziemne_kondygnacje>parking podziemny</podziemne_kondygnacje>
      <wykonczenie><![CDATA[Standard developerski]]></wykonczenie>
      <wycena_powierzchni></wycena_powierzchni>
      <harmonogram_platnosci>I rata 5%, II rata 70%,...</harmonogram_platnosci>
      <zdjecie>http://ofertymieszkan.pl/system/photos/000/000/930/original/w.jpg</zdjecie> 
      <zdjecia> 
        <zdjecie>http://ofertymieszkan.pl/system/files/000/006/894/original/w.jpg</zdjecie> 
        <zdjecie>http://ofertymieszkan.pl/system/files/000/006/895/original/c.jpg</zdjecie> 
      </zdjecia>
      <oferty>
        <oferta>
          <id>om-930-1</id>
          <url>http://ofertymieszkan.pl/nieruchomosci/930/oferty/1</url>
          <status>1</status>
          <nazwa>VII-08</nazwa>
          <powierzchnia>50</powierzchnia>
          <cena>200000</cena>
          <cena_za_metr>4000.00</cena_za_metr>
          <rzut>http://ofertymieszkan.pl/system/projections/193/original/1897.png</rzut>
          <wysokosc>2.75</wysokosc>
          <liczba_pokoi>2</liczba_pokoi>
          <pietro>2</pietro>
          <rodzaj_garazu>miejsce postojowe podziemne</rodzaj_garazu>
          <cena_garazu>15000</cena_garazu>
          <rodzaj_powierzchni_dodatkowej>balkon</rodzaj_powierzchni_dodatkowej>
        </oferta>
        <oferta>
          <id>om-930-2</id>
          <url>http://ofertymieszkan.pl/nieruchomosci/930/oferty/2</url>
          <status>1</status>
          <nazwa>VII-05</nazwa>
          <powierzchnia>60</powierzchnia>
          <cena>440000</cena>
          <cena_za_metr>7333.33</cena_za_metr>
          <rzut>http://ofertymieszkan.pl/system/projections/193/original/1897.png</rzut>
          <wysokosc>2.75</wysokosc>
          <liczba_pokoi>2</liczba_pokoi>
          <pietro>1</pietro>
          <rodzaj_garazu>miejsce postojowe podziemne</rodzaj_garazu>
          <cena_garazu>15000</cena_garazu>
          <rodzaj_powierzchni_dodatkowej>balkon</rodzaj_powierzchni_dodatkowej>
        </oferta>
      </oferty>
      <dodatki>
        <dodatek>basen</dodatek>
        <dodatek>fitness club</dodatek>
        <dodatek>internet</dodatek>
        <dodatek>plac zabaw</dodatek>
      </dodatki>
    </inwestycja>
  </inwestycje>
</dane>