Pobieranie całości danych z serwisu OfertyMieszkan.pl

Zasady ogólne

Cała baza danych jest udostępniona w formacie XML. Dane nie są w żaden sposób porcjowane czy różnicowane w zależności od klucza API. Plik XML zawiera wszystkie oferty, które są widoczne publicznie w serwisie. Kodowanie tekstu jest zawsze za pomocą standardowego UTF-8. Serwis zawiera jedynie oferty z co najmniej jednym zdjęciem. Wszystkie oferty importowane od agencji, które nie posiadają zdjęć, są przez system odrzucane, dlatego można mieć pewność, że wszystkie oferty wystawione przez niniejsze API będą posiadać co najmniej jedno zdjęcie

Autentykacja przez klucz API

Przed jakąkolwiek próbą pobrania, trzeba uzyskać klucz API. W tym celu należy się skontaktować z administratorem serwisu. Wysyłanie żądań bez klucza API lub z nieprawidłowym kluczem, zwróci błąd 404 Not found.

Klucz API należy za każdym razem wysyłać w żądaniu jako zwykły parametr GET:

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

Eksporty różnicowe

API serwisu OfertyMieszkan.pl nie wysyła eksportów różnicowych. Plik XML zawiera całość naszej bazy danych, niezależnie od daty pobierania oraz klucza API. Można zatem założyć, że:

  • Wszystkie oferty, które występowały w eksporcie poprzednim, a nie występują w aktualnym, zostały usunięte z serwisu OfertyMieszkan.pl i należy je usunąć.
  • Wszystkie oferty, które nie występowały w eksporcie poprzednim, a występują w aktualnym, zostały dodane lub wznowiono ich emisję. Należy je wtedy zaimportować do bazy.
  • Wszystkie oferty, które występowały w poprzednim eksporcie i występują w aktualnym, należy przebadać pod kątem pola data_aktualizacji. System automatycznie aktualizuje datę przy każdej modyfikacji oferty. Jakakolwiek zmiana wartości tego pola jest sygnałem, że należy zaktualizować ofertę.
  • Każda oferta ma swój stały identyfikator zawarty w polu id, który jest w formacie om-[numer]. Niezależnie od typu transakcji, rodzaju rynku czy rodzaju nieruchomości, oferta zidentyfikowana przez numer np. om-1902002 jest zawsze tą samą ofertą.

Zdjęcia i obrazki

Plik XML zawiera bezwzględne adresy zdjęć i obrazków. Podane w dokumencie adresy kierują do plików oryginalnych, tj. nieprzetworzonych i niepomniejszonych. Dotyczy to nie tylko wymiarów obrazka, ale także jego formatu. Ponieważ akceptujemy nie tylko standardowe formaty JPEG oraz PNG, ale również PDF, EPS, TIFF itp, to można się spodziewać, że niektóre pliki będą wymagały konwersji, aby można je było poprawie wyświetlić na stronie.

Udostępnienie niepomniejszonych i nieprzetworzonych plików umożliwia serwisom partnerskim dostosowanie ich formatu i rozmiaru do swojej własnej polityki i szaty graficznej. Przykładową biblioteką, dostępną jako Open Source, jest ImageMagick, która doskonale radzi sobie praktycznie z każdym formatem graficznym.

Testowanie pobierania danych

Plik XML ze wszystkimi ofertami może się okazać zbyt duży, do wygodnego pobrania, a tym bardziej do wczytania przez parser XML. Dla wygody, można dla testów określić maksymalną liczbę rekordów, jaka będzie. Dokonać tego można za pomocą parametru GET o nazwie limit:

http://ofertymieszkan.pl/api/oferty/wtorny.xml?key=KLUCZAPI&limit=10

Przykładowy eksport z jedną ofertą

<?xml version="1.0" encoding="UTF-8"?>
<dane data-aktualizacji="2010-09-26 00:00:00">
  <oferty rynek="wtorny"> 
    <oferta typ-lokalu="mieszkanie" transakcja="sprzedaz"> 
      <id>om-19205</id> 
      <numer_oferty>PF-1001</numer_oferty> 
      <firma>Przykładowa firma</firma> 
      <data_dodania>2010-06-23 00:00:00</data_dodania> 
      <data_aktualizacji>2010-09-18 22:04:22</data_aktualizacji> 
      <cena>349000</cena> 
      <powierzchnia>55</powierzchnia> 
      <wojewodztwo text-id="malopolskie">małopolskie</wojewodztwo> 
      <miasto>Kraków</miasto> 
      <dzielnica>Nowa Huta</dzielnica> 
      <url>http://ofertymieszkan.pl/nieruchomosci/1-mieszkanie-dwupokojowe</url> 
      <kontakt_osoba>Beata Kowalska</kontakt_osoba> 
      <kontakt_email>beata@agencja-przykladowa.pl</kontakt_email> 
      <kontakt_telefon>123-456-789</kontakt_telefon> 
      <geo_szer>50.19281000</geo_szer> 
      <geo_dl>20.1294810</geo_dl> 
      <atrybuty> 
        <atrybut text-id="liczba-pokoi" pelna-nazwa="Liczba pokoi">2</atrybut> 
        <atrybut text-id="typ-zabudowy" pelna-nazwa="Typ zabudowy">kamienica</atrybut> 
        <atrybut text-id="material" pelna-nazwa="Materiał">cegła</atrybut> 
        <atrybut text-id="czynsz" pelna-nazwa="Czynsz">160.0</atrybut> 
      </atrybuty> 
      <zdjecie>http://ofertymieszkan.pl/photos/000/001/original/1248_1.jpg</zdjecie> 
      <zdjecia> 
        <zdjecie>http://ofertymieszkan.pl/files/000/003/original/zdj2.jpg</zdjecie> 
        <zdjecie>http://ofertymieszkan.pl/files/000/004/original/zdj5.jpg</zdjecie> 
      </zdjecia> 
      <opis> 
        <![CDATA[To jest przykładowy opis, mogący zawierać nawet znaczniki HTML.]]>
      </opis> 
    </oferta>
  </oferty>
</dane>
    
Informujemy, że nasza witryna wykorzystuje cookies (ciasteczka) w celu poprawnego funkcjonowania. Więcej informacji… ×