Jakidom.pl REST API Dokumentacja (1.0.1)
Poprzez API Jakidom.pl możesz uzyskać dostęp do wszystkich usług oferowanych przez system. Poniższa dokumentacja zawiera najczęściej wykorzystywane funkcjonalności.
Aby uzyskać dostęp do API Jakidom.pl, w pierwszej kolejności załóż konto w serwisie Jakidom.pl. Po dokonanej rejestracji, klient ma możliwość śledzenia wszystkich ogłoszeń oraz edycji, aktywacji oraz usuwania ich z systemu.
Przebieg korzystania z REST API.
1. Authentication

Basic Auth
Jest to podstawowa metoda uwierzytelnienia. Po podaniu danych uwierzytelniających User(email) oraz password(hasło) a następnie wysyłamy:
1. REQUEST: POST https://jakidom.pl/apiogloszenie/login AuthorizationBasic Auth
Username : email
Password : hasło
2. Response :
Błędna autoryzacja :{
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane{
"error": "Invalid input data",
"code": 400
}
Otrzymujemy Token {
"token": "810701a6a8e9f585c5a6b142de542d362a0b92a3457507b0835dc621b34bbb34"
}
Bearer Token
Dalsza komunikacja odbywa się z uwierzytelnianiem na podstawie otrzymanego tokena.
2. Dodanie ogłoszenia

1. REQUEST: POST https://jakidom.pl/apiogloszenie/v1/ AuthorizationBearer Token
Token: token
Content type application/json
{
"typnieruchomosci_id": int,
"tytul": string,
"cena": number,
"powierzchnia": number,
"typ_ogloszenia": int,
"opis": string,
"typ_ogloszeniodawcy": int,
"imieNazwisko": string,
"email": string,
"phone": string,
"adres":{
"latitude": number,
"longitude": number
}
"dodatki":[
int,
int,
.....
]
}
- Pole: "typnieruchomosci_id" - *wymagane wartość jak w tabeli:
Typ Nieruchomości |
---|
1 | Mieszkanie |
2 | Dom |
3 | Działka |
4 | Lokal użytkowy |
5 | Pokój |
6 | Magazyn |
7 | Garaż |
8 | Wiata |
- Pole: "tytul" - *wymagane wartość: Tytuł ogłoszenia na stronie Minimalna ilość znaków to 10.
- Pole: "cena" - *wymagane wartość: Cena nieruchomości podana jako 123 lub 123.99
- Pole: "powierzchnia" - *wymagane wartość: Cena nieruchomości podana jako 123 lub 123.99
- Pole: "typ_ogloszenia" - *wymagane wartość: 0 oznacza 'Sprzedam', 1 - 'Wynajmę', 2 - 'Zamienię'
- Pole: "opis" - wartość: Pole tekstowe . Może zawierać prosty kod html " Piękna nieruchomość"
- Pole: "typ_ogloszeniodawcy" - *wymagane wartość: 0 oznacza 'Właściciel', 1 - 'Pośrednik'
- Pole: "imieNazwisko" - *wymagane wartość: Pole tekstowe. Zawiera Imę i nazwisko ogłsoszenodawcy.
- Pole: "email" - wartość: Pole tekstowe. Zawiera email ogłsoszenodawcy. Puste pole pobiera dane z konta użytkownika.
- Pole: "phone" - wartość: Pole tekstowe. Zawiera telefon ogłsoszenodawcy. Puste pole pobiera dane z konta użytkownika jeśli brak w koncie użytkownika należy go podać
- Pole: adres { "latitude" } - *wymagane wartość: Pole Latitude – szerokość geograficzna 51.752826
- Pole: adres { "longitude" } - *wymagane wartość: Pole Latitude – długość geograficzna 51.752826
- Pole: "dodatki" - wartość: Tablica liczb przedstawiających dodatkowe informację o nieruchomości
DODATKI:
Media |
---|
1 | Internet | 2 | Telewizja Kablowa | 3 | Telefon |
Typ nieruchomości |
---|
Pokój | Mieszkanie | Magazyn | Lokal użytkowy | Dom |
| Zabezpieczenia |
---|
4 | Drzwi antywłamaniowe | 5 | Okna antywłamaniowe | 6 | Rolety zewnętrzne | 7 | Domofon | 8 | Teren zamknięty | 9 | System alarmowy | 10 | Monitoring | 11 | Ochrona |
Typ nieruchomości: |
---|
Mieszkanie | Magazyn | Lokal użytkowy | Garaż | Dom |
| Przeznaczenie |
---|
12 | magazynowe | 13 | produkcyjne | 14 | biurowe | 15 | handlowe |
Typ nieruchomości: |
---|
Magazyn |
| Wyposażenie |
---|
16 | Meble | 17 | Pralka | 18 | Zmywarka | 19 | Lodówka | 20 | Kuchenka | 21 | Piekarnik | 22 | Telewizor | 23 | Klimatyzacja |
Typ nieruchomości: |
---|
Mieszkanie | Lokal użytkowy | Dom |
| Informacje dodatkowe |
---|
24 | Balkon | 25 | Piwnica | 26 | Winda | 27 | Ogródek | 28 | Dwupoziomowe | 29 | Garaż | 30 | Miejsce parkingowe | 31 | Taras |
Typ nieruchomości: |
---|
Mieszkanie |
|
Ogrzewanie |
---|
32 | Olejowe | 33 | Kominkowe | 34 | Węglowe | 35 | Kolektor słoneczny | 36 | Elektryczne | 37 | Piece kaflowe | 38 | Biomasa | 39 | Geotermika | 40 | Miejskie | 41 | Gazowe | 42 | Pompa ciepła |
Typ nieruchomości: |
---|
Magazyn | Lokal użytkowy | Dom |
| Ogrodzenie |
---|
43 | Murowane | 44 | Drewniane | 45 | Siatka | 46 | Betonowe | 47 | Metalowe | 48 | Żywopłot |
Typ nieruchomości: |
---|
Wiata | Magazyn | Działka |
| Dojazd |
---|
49 | Polny | 50 | Asfaltowy | 51 | Utwardzony |
Typ nieruchomości: |
---|
Magazyn | Działka | Dom |
| Przyłącza |
---|
52 | Prąd | 53 | Woda | 54 | Kanalizacja | 55 | Szambo | 56 | Oczyszczalnia | 57 | Gaz | 58 | Telefon |
Typ nieruchomości: |
---|
Działka | Dom |
| Okolica |
---|
59 | Las | 60 | Góry | 61 | Morze | 62 | Jezioro | 63 | Rzeka |
Typ nieruchomości: |
---|
Mieszkanie | Działka | Dom |
|
2. Response :
Błędna autoryzacja :{
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Invalid input data",
"code": 400
}
Ogłoszenie w postaci tablicy : {
"ogloszenie": {},
"status": "Ogłoszenie dodano."
}
3. Dodanie zdjęć do ogłoszenia
1. REQUEST: POST https://jakidom.pl/apiogloszenie/v1/{slug}/okladka AuthorizationBearer Token
Token: token
Content type form-data
Aby dodać zdjecia do ogłoszenia potrzebna zmienna {slug} danego odłoszenia.Warunkiem konieczny jest: Ogłoszenie musi istnieć . Pola ze zdjęciami numerujemy file, file1, flie2, .... Pierwszy plik będzie okładką.
Request example: Body form-data
file yeI3UTyJa/Rest API.png
file1 -PWWaXy2k/Hydrangeas.jpg
fille.... nameFile
2. Response :
Błędna autoryzacja : {
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Invalid input data",
"code": 400
}
{
"status": "Zdjęcia dodano."
}
4. Usunięcie zdjęcia z ogłoszenia
1. REQUEST: DELETE https://jakidom.pl/apiogloszenie/v1/{slug}/okladka/{id} AuthorizationBearer Token
Token: token
Aby usunąć zdjęcie z ogłoszenia potrzebna zmienna {slug} danego ogłoszenia oraz {id} danego zdjęcia.
2. Response :
Błędna autoryzacja : {
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Brak zdjęcia",
"code": 400
}
{
"status": "Zdjęcie usunieto."
}
5. Pobranie ogłoszeń użytkownika

1. REQUEST: GET https://jakidom.pl/apiogloszenie/v1/ AuthorizationBearer Token
Token: token
Content type application/json
{
order:string,
page: int
perPage: int
}
- Pole: "order" - wartość: pole po którym ogłoszenia mają być posortowane.
- Pole: "page" - wartość: strona z tablicą ogłoszeń
- Pole: "perPage" - wartość: ilość ogłoszeń na stronę
2. Response :
Błędna autoryzacja :{
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane{
"error": "Invalid input data",
"code": 400
}
Ogłoszenia w postaci tablicy {
"ogloszenia": [],
"per_page": int,
"total": int,
"page": int
}
6. Pobranie ogłoszenia

1. REQUEST: GET https://jakidom.pl/apiogloszenie/v1/{slug} AuthorizationBearer Token
Token: token
Aby pobrać ogłoszenie potrzebna jest zmienna {slug} danego ogłoszenia.
2. Response :
Błędna autoryzacja :{
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Brak ogłoszenia",
"code": 400
}
Ogłoszenie w postaci tablicy {
"ogloszenie": [],
}
7. Aktualizacja ogłoszenia

1. REQUEST: PUT https://jakidom.pl/apiogloszenie/v1/{slug} AuthorizationBearer Token
Token: token
Aby zaktualizować ogłoszenie potrzebna jest zmienna {slug} danego ogłoszenia.
Content type application/json
{
"typnieruchomosci_id": int,
"tytul": string,
"cena": number,
"powierzchnia": number,
"typ_ogloszenia": int,
"opis": string,
"typ_ogloszeniodawcy": int,
"imieNazwisko": string,
"email": string,
"phone": string,
"adres":{
"latitude": number,
"longitude": number
}
"dodatki":[
int,
int,
.....
]
}
Jeśli występuje dana w żądaniu wartość tej dane zostanie zastąpiona w ogłoszeniu.
- Pole: "typnieruchomosci_id"
Typ Nieruchomości |
---|
1 | Mieszkanie |
2 | Dom |
3 | Działka |
4 | Lokal użytkowy |
5 | Pokój |
6 | Magazyn |
7 | Garaż |
8 | Wiata |
- Pole: "tytul" - wartość: Tytuł ogłoszenia na stronie Minimalna ilość znaków to 10.
- Pole: "cena" - wartość: Cena nieruchomości podana jako 123 lub 123.99
- Pole: "powierzchnia" - *wymagane wartość: Cena nieruchomości podana jako 123 lub 123.99
- Pole: "typ_ogloszenia" - *wymagane wartość: 0 oznacza 'Sprzedam', 1 - 'Wynajmę', 2 - 'Zamienię'
- Pole: "opis" - wartość: Pole tekstowe . Może zawierać prosty kod html " Piękna nieruchomość"
- Pole: "typ_ogloszeniodawcy" - *wymagane wartość: 0 oznacza 'Właściciel', 1 - 'Pośrednik'
- Pole: "imieNazwisko" - *wymagane wartość: Pole tekstowe. Zawiera Imię i nazwisko ogłoszeniodawcy.
- Pole: "email" - wartość: Pole tekstowe. Zawiera email ogłoszeniodawcy. Puste pole pobiera dane z konta użytkownika.
- Pole: "phone" - wartość: Pole tekstowe. Zawiera telefon ogłoszeniodawcy. Puste pole pobiera dane z konta użytkownika jeśli brak w koncie użytkownika należy go podać
- Pole: adres { "latitude" } - *wymagane wartość: Pole Latitude – szerokość geograficzna 51.752826. Jeśli występuje pole adres poprzedni adres zostanie zastąpiony
- Pole: adres { "longitude" } - *wymagane wartość: Pole Latitude – długość geograficzna 51.752826. Jeśli występuje pole adres poprzedni adres zostanie zastąpiony
- Pole: "dodatki" - wartość: Tablica liczb przedstawiających dodatkowe informację o nieruchomości. Jeśli występuje pole "dodatki" poprzednie pole "dodatki" zostanie zastąpione.
2. Response :
Błędna autoryzacja :{
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Brak ogłoszenia",
"code": 400
}
Ogłoszenie w postaci tablicy {
"ogloszenie": [],
}
8. Usunięcie ogłoszenia
1. REQUEST: DELETE https://jakidom.pl/apiogloszenie/v1/{slug} AuthorizationBearer Token
Token: token
Aby usunąć ogłoszenie potrzebna jest zmienna {slug} danego ogłoszenia.
2. Response :
Błędna autoryzacja : {
"error": "Unauthorized Accesss",
"code": 401
}
Błędne dane : {
"error": "Brak ogłoszenia",
"code": 400
}
{
"status": "Ogłoszenie usunięte."
}