ZakopaneApartamenty.pl REST


Bazowy URL: https://api.zakopaneapartamenty.net.pl/v1


Endpoint:

/objects

Pobiera listę obiektów z uwzględnieniem parametrów do wyszukiwania i stronicowania.
Puste parametry wyszukiwania zwrócą listę wszystkich apartamentów.
Parametry Opis
lang (string) Wersja językowa: pl, en, ru
arrival (string) Y-m-d | Data przybycia (parametr wyszukiwarki)
departure (string) Y-m-d | Data odjazdu (parametr wyszukiwarki)
people (int) Ilość osób dla których wyszukiwarka oblicza ceny na podstawie daty przyjazdu i odjazdu (parametr wyszukiwarki)
rooms_1 (bool) Jeżeli true lista wyników zawiera apartamenty typu STUDIO
rooms_2 (bool) Jeżeli true lista wyników zawiera apartamenty z 1 sypialnią
rooms_3 (bool) Jeżeli true lista wyników zawiera apartamenty z 2 sypialniami
rooms_4 (bool) Jeżeli true lista wyników zawiera apartamenty z 3 sypialniami
rooms_5 (bool) Jeżeli true lista wyników zawiera apartamenty z 4 sypialniami
bathrooms_2 (bool) Jeżeli true lista wyników zawiera apartamenty z 2 łazienkami
balcony_terrace (bool) Jeżeli true lista wyników zawiera apartamenty z posiadające balkon lub taras
last_minute (bool) Jeżeli true lista wyników zawiera apartamenty LAST MINUTE
house (bool) Jeżeli true lista wyników zawiera apartamenty typu DOMEK
fireplace (bool) Jeżeli true lista wyników zawiera apartamenty Z KOMINKIEM
bathtub (bool) Jeżeli true lista wyników zawiera apartamenty Z WANNĄ
sauna (bool) Jeżeli true lista wyników zawiera apartamenty Z sauną
spa (bool) Jeżeli true lista wyników zawiera apartamenty Z SPA
jacuzzi (bool) Jeżeli true lista wyników zawiera apartamenty Z jacuzzi
jim (bool) Jeżeli true lista wyników zawiera apartamenty Z siłownią
playground (bool) Jeżeli true lista wyników zawiera apartamenty Z placem zabaw
air_conditioning (bool) Jeżeli true lista wyników zawiera apartamenty Z klimatyzacją
washing_machine (bool) Jeżeli true lista wyników zawiera apartamenty Z pralką
wifi (bool) Jeżeli true lista wyników zawiera apartamenty Z WIFI
pool (bool) Jeżeli true lista wyników zawiera apartamenty Z BASENEM
regional (bool) Jeżeli true lista wyników zawiera apartamenty typu REGIONALNE
disabled_friendly (bool) Jeżeli true lista wyników zawiera apartamenty PRZYJAZNE DLA NIEPELNOSPRAWNYCH
allow_pets (bool) Jeżeli true lista wyników zawiera apartamenty które mają w ofercie pozwolenie na zwierzę
distance (int) Maksymalna ilość metrów od centrum
promotion (bool) Jeżeli true lista wyników zawiera apartamenty oznaczone jako PROMOCJE
complex_id (int) Filtruje apartamenty po ID kompleksu
geo_complex_id (int) Filtruje apartamenty po ID kompleksu geograficznego
group_id (int | array of integers (1,2,3,4,5,6,7)) Filtruje apartamenty po ID grupy apartamentu
near_id (int) Pokazuje tylko te apartamenty które są w pobliżu apartamentu o wskazanym ID
mountain_view (bool) Jeżeli true lista wyników zawiera apartamenty z widokiem na góry
sort_by (string) Kolumna po której sortowana jest lista
sort_order (string) asc | desc Kolejność sortowania
offset (int) Odsunięcie, działa analogicznie do MySql
limit (int) Analogicznie do MySql
sorttoken (string) Lista wyników zwracana jest domyślnie w kolejności losowej (jeżeli nie ustalimy kolumny sortowania).
Losowa kolejność powoduje, że nie możemy podzielić listy wyników na strony (każda strona zwraca losowe wyniki).

Parametr został wprowadzony aby zapamiętać kolejność sortowania i dopóki jest dostarczany taki sam klucz lista wyników będzie się sortowac w ten sam sposób.

Np.:
- sortowanie bez tego parametru zwróci za każdym razem losową kolejność
- przekazanie paramentru 123ABC za pierwszym razem zwróci losową kolejność
- ponowne przekazanie tego samego klucza sortowania 123ABC zwróci wyniki z tą samą kolejnośią jaka została wygenerowana pierwszy raz dla tego klucza (klucze przechowywane są 60 minut)
- każda kolejna zmiana klucza zmienia kolejność obiektów
phrase (string) Fraza wyszukiwania po nazwie apartamentu

Endpoint:

/objects/{symbol}

Zwraca wszystkie dane obiektu wraz ze zdjęciami, sezonami itp.
Parametry Opis
{symbol} (string) Symbol obiektu, zwracany na liście obiektów pod zmienną symbol
lang (string) Wersja językowa: pl, en, ru

Endpoint:

/groups

Zwraca listę grup apartamentów
Parametry Opis

Endpoint:

/complexes

Zwraca listę kompleksów
Parametry Opis
lang (string) Wersja językowa: pl, en, ru

Endpoint:

/complexes/{symbol}

Zwraca wszystkie dane kompleksu wraz z listą przypisanych do niego obiektów.
Parametry Opis
{symbol} (string) Symbol kompleksu, zwracany na liście kompleksów pod zmienną symbol
lang (string) Wersja językowa: pl, en, ru

Endpoint:

/complexes_geo

Zwraca listę kompleksów geograficznych.
Parametry Opis

Endpoint:

/justBooked/{limit}

Zwraca listę ostatnio rezerwowanych obiektów
Parametry Opis
{limit} (int) Ilość zwracanych wyników

Endpoint:

/leastBooked/{limit}

Zwraca listę najmniej rezerwowanych obiektów z ostatnich dwóch tygodni
Parametry Opis
{limit} (int) Ilość zwracanych wyników
complex_id (int) Filtruje apartamenty po ID kompleksu

Endpoint:

/opinions/{objectId}

Zwraca listę opinii dla danego obiektu
Parametry Opis
{objectId} (int) Id obiektu

Endpoint:

POST /opinion

Zapis opinii
Parametry Wymagany Opis
object_id tak (int) ID obiektu
cleanliness tak (int) ocena od 1 do 10
equipment tak (int) ocena od 1 do 10
localization tak (int) ocena od 1 do 10
condition tak (int) ocena od 1 do 10
compatibility tak (int) ocena od 1 do 10
personnel tak (int) ocena od 1 do 10
lang tak (string) Wersja językowa: pl, en, ru
notes (string) Dodatkowe informacje
name (string) Nazwa opiniującego
city (string) Miasto opiniującego

Endpoint:

POST /newsletter

Zapis na newsletter
Parametry Wymagany Opis
email tak (string) adres email
lang tak (string) Wersja językowa: pl, en, ru
domain tak (string) domena

Endpoint:

POST /email

Zapis do kolejki
Parametry Wymagany Opis
to tak (string) adres email
from tak (string) adres email
reply tak (string) adres email
subject tak (string) temat
message tak (string) wiadomosc

Endpoint:

POST /user_registration

Rejestracja użytkownika
Parametry Wymagany Opis
email tak (string) adres email
password tak (string) hasło
password_confirmation tak (string) ponownie wprowadzone hasło
first_name tak (string) Imię
last_name tak (string) Nazwisko
company_name (string) nazwa firmy
street (string) Ulica
city (string) Miejscowość
postal_code (string) Kod pocztowy
country (string) Kraj
phone tak (string) Telefon
regulations tak (int) Akceptacja regulaminu 0|1
newsletter (int) Jeżeli 1 zapisuje do newslettera podczas rezerwacji 0|1
domain tak (string) domena z której rejestracja
ip tak (string) ip z którego rejestracja
lang tak (string) Wersja językowa: pl, en, ru

Endpoint:

POST /remind_password

Przypomnienie hasła
Parametry Wymagany Opis
email tak (string) adres email

Endpoint:

POST /oauth/access-token

Oauth2 Access Token - zwraca access token oraz refresh token
Parametry Wymagany Opis
clinet_id tak (string) Id klienta, dla każdej aplikacji korzystającej z API generowane nowe ID
clinet_secret tak (string) secret key, dla każdej aplikacji korzystającej z API generowane nowy
grand_type tak (string)
password - logowanie użytkownika
refresh_token - odświeżenie tokena
jeżeli grand_type == password, dodatkowy parametr:
username		 tak (string) adres email użytkwonika/login
jeżeli grand_type == password, dodatkowy parametr:
password		 tak (string) hasło użytkownika
jeżeli grand_type == refresh_token, dodatkowy parametr:
refresh_token		 tak (string) token odswieżający

Endpoint:

/description

Pobranie strony opisowej z panelu admin .net.pl
Parametry Wymagany Opis
recordId tak string | int

Endpoint:

/user

Pobranie danych użytkownika
Endpoint wymaga przesłania tokena logowania w nagłówku:
"Authorization: Bearer {TOKEN}"

Endpoint:

POST /user

Aktualizacja danych użytkownika
Endpoint wymaga przesłania tokena logowania w nagłówku:
"Authorization: Bearer {TOKEN}"
Parametry Wymagany Opis
email tak (string) adres email
first_name tak (string) Imię
last_name tak (string) Nazwisko
company_name (string) nazwa firmy
street (string) Ulica
city (string) Miejscowość
postal_code (string) Kod pocztowy
country (string) Kraj
phone tak (string) Telefon

Endpoint:

POST /user/password

Zmiana hasła
Endpoint wymaga przesłania tokena logowania w nagłówku:
"Authorization: Bearer {TOKEN}"
Parametry Wymagany Opis
current_password tak (string) obecne hasło
password tak (string) nowe hasło
password_confirmation tak (string) nowe hasło, potwierdzenie

Endpoint:

/user/newsletter/unsubscribe

Wypisanie z newslettera obecnego użytkownika
Endpoint wymaga przesłania tokena logowania w nagłówku:
"Authorization: Bearer {TOKEN}"

Endpoint:

/user/reservations

Pobranie wszystkich rezerwacji danego użytkownika
Endpoint wymaga przesłania tokena logowania w nagłówku:
"Authorization: Bearer {TOKEN}"