Zielona Góra

 Integracja API
Udostêpniamy naszym u¿ytkownikom interfejs API, dziêki któremu mo¿na w zautomatyzowany sposób dodaæ wiêksz± ilo¶æ og³oszeñ do serwisu lub dokonywaæ eksportu og³oszeñ z serwisu partnerskiego.

  1. Jak rozpocz±c korzystanie z API?
  2. Przesy³anie zapytañ
  3. Zwracane odpowiedzi
  4. Autoryzacja
  5. Jak dodaæ og³oszenie za pomoc± API?
  6. Pobieranie listy kategorii
  7. Pobieranie listy miast
  8. Jak dodaæ og³oszenie Premium lub Wyró¿nione?
  9. Jak dodaæ zdjêcia do og³oszenia
  10. Wy¶wietlenie listy zdjêæ dodanych do og³oszenia
  11. Wy¶wietlenie zdjêcia dodanego do og³oszenia
  12. Usuniêcie pojedyñczego zdjêcia
  13. Usuniêcie wszystkich zdjêæ z og³oszenia
  14. Edycja og³oszenia
  15. Usuniêcie og³oszenia
  16. Sprawdzenie limitu konta
  17. Jak zwiêkszyæ limit dla konta??
Jak rozpocz±c korzystanie z API?
Aby rozpocz±æ korzystanie z API nale¿y wygenerowaæ klucz API.

Klucz API jest unikalny dla ka¿dego u¿ytkownika i powinien byæ traktowany jak has³o do konta.

W celu wygenerowania klucza API przejd¼ na tê stronê.
Przesy³anie zapytañ
API zosta³o napisane wed³ug standardu REST i dostêpne jest pod adresem https://api.oglaszamy24.pl/api/

Zarówno zapytania, jak i odpowiedzi przesy³ane s± za pomoc± protoko³u HTTPS.

API obs³uguje 4 dostêpne metody zapytañ: POST, GET, PUT, DELETE.

W przypadku zapytañ POST oraz PUT nale¿y przes³aæ odpowiednie dane jako parametr "data". Przesy³ane dane musz± byæ w formacie JSON a znaki musz± byæ zakodowane w standardzie UTF-8.
Zwracane odpowiedzi
Po przes³aniu zapytania API zwróci odpowied¼ w formacie JSON. Znaki zakodowane bêd± w formacie UTF-8.

W przypadku poprawnej odpowiedzi zwrócona odpowied¼ zawieraæ bêdzie pola:
  • status - pole przyjmie warto¶æ "ok"
oraz opcjonalnie nastêpuj±ce pola:
  • message - komunikat przes³any jako odpowied¼
  • data - dane przes³ane w odpowiedzi
Przyk³adowa poprawna odpowied¼:

{"status":"ok", "message":"hello", "data":{"method":"GET"}}


W przypadku b³êdnej odpowiedzi zwrócona odpowied¼ zawieraæ bêdzie pola:
  • status - pole przyjmie warto¶æ "error"
  • message - w polu znajdzie siê komunikat z b³êdem
  • code - kod b³êdu
Przyk³adowa b³êdna odpowied¼:

{"status":"error", "message":"Niepoprawna komenda API.", "code":9}
Autoryzacja
Do ka¿dego zapytania nale¿y przes³aæ klucz API.

Klucz API musi zostaæ przes³any w nag³ówku header zapytania jako parametr API-Key.

Przyk³adowe przes³anie klucza API za pomoc± biblioteki CURL.

curl -X GET -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/hello

Przyk³adowe przes³anie klucza API za pomoc± PHP:

$api_key = 'TWOJ-KLUCZ-API';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/hello');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);

W odpowiedzi serwer powinien zwróciæ nastêpuj±c± odpowied¼:

{"status":"ok", "message":"hello", "data":{"method":"GET"}}
Jak dodaæ og³oszenie za pomoc± API?
W celu dodania og³oszenia za pomoc± API nale¿y wys³aæ dane og³oszenia zakodowane w formacie JSON (kodowanie znaków w UTF-8).

Dane musz± zostaæ przes³ane za pomoc± metody POST jako parametr "data" na adres:

https://api.oglaszamy24.pl/api/adverts

Dane mog± zawieraæ nastêpuj±ce pola:

Parametr
Obowi±zkowy
Typ
Opis
title
obowi±zkowy
string
Tytu³ og³oszenia. Minimalna d³ugo¶æ to 5 znaków.
description
obowi±zkowy
string
Tre¶æ og³oszenia. Maksymalna d³ugo¶æ to 4000 znaków. Nowe linie w opisie nale¿y oddzielaæ za pomoc± znacznika: \r\n
cat1_id
obowi±zkowy
integer
ID podstawowej kategorii (zobacz poni¿ej pobieranie listy kategorii)
cat2_id
obowi±zkowy
integer
ID podkategorii drugiego rzêdu. Je¿eli podkategoria drugiego rzêdu zawiera podkategorie trzeciego rzêdu, nale¿y wówczas okre¶liæ ID kategorii trzeciego rzêdu (cat3_id).
cat3_id
obowi±zkowy
integer
ID podkategorii trzeciego rzêdu. W przypadku gdy dana podkategoria drugiego rzêdu nie posiada dalszych podkategorii warto¶æ nale¿y ustawiæ jako 0.
contact_name
obowi±zkowy
string
Imie osoby kontaktowej
telephone
nieobowi±zkowy
integer
Numer telefonu kontaktowego. Bez spacji. W przypadku kierunkowego wpisaæ 00 zamiast +.
email_disabled
nieobowi±zkowy
integer
Dostêpne warto¶ci: 0 lub 1. W przypadku gdy nie chcemy otrzymywaæ odpowiedzi mailem a jedynie telefonicznie nale¿y ustawiæ warto¶æ parametru jako 1.
ad_sell
nieobowi±zkowy
integer
Liczba ca³kowita okre¶laj±ca rodzaj oferty. Dostêpne warto¶ci: 1 lub 2. Je¿eli oferta dotyczy sprzeda¿y/wynajmu komu¶/oferowania us³ug ustaw warto¶æ parametru jako 1, je¿eli oferta dotyczy kupna/wynajmu od kogo¶/poszukiwania us³ug ustaw warto¶æ parametru jako 2. W przypadku pominiêcia parametru, przyjmie on domy¶ln± warto¶æ 1.
price
nieobowi±zkowy
integer
Cena w z³. Dotyczy przedmiotów wystawionych na sprzeda¿ lub oferowanch us³ug.
city_id
nieobowi±zkowy
integer
ID miasta do którego chcemy dodaæ og³oszenie (zobacz poni¿ej pobieranie listy miast). Je¿eli chcemy aby og³oszenie wy¶wietla³o siê we wszystkich miastach, nale¿y podaæ warto¶æ 0.
ad_type
nieobowi±zkowy
integer
rodzaj og³oszenia (dostêpne warto¶ci: 1,2 lub 3). 1 - og³oszenie standardowe, 2 - og³oszenie premium, 3 - og³oszenie wyró¿nione. W przypadku dodawania og³oszenia premium lub wyró¿nionego nale¿y uprzednio zakupiæ pakiet og³oszeñ Wyró¿nionych lub Premium.
auto_renewal
nieobowi±zkowy
integer
Dostêpne warto¶ci: 1 lub 0. Je¿eli chcemy aby og³oszenie Premium lub Wyró¿nionych by³o automatycznie ponawiane wówczas ustaw warto¶æ parametru jako 1. Aby og³oszenie mog³o byæ automatycznie ponowione nale¿y, w momencie ponawiania, posiadaæ aktywny pakiet og³oszeñ Wyró¿nionych lub Premium.
extra_info
nieobowi±zkowy
array
Dodatkowe informacje dostêpne w przypadku niektórych kategorii takich jak nieruchomo¶ci czy motoryzacja (zobacz poni¿ej)


Uwagi:
W przypadku ustawienia warto¶ci parametru email_disabled jako 1 parametr telephone bêdzie obowi±zkowy.

Domy¶lnie og³oszenia bêd± dodawane z adresem email kontaktowym podanym podczas rejestracji konta. Je¿eli exportujesz og³oszenia z serwisu partnerskiego lub chcia³by¶ dodawaæ og³oszenia z ró¿nymi adresami email - skontaktuj siê z nami.



Parametr extra_info:

Parametr extra_info to tablica sk³adaj±ca siê z pól info1...info12. W parametrze extra_info, w polach info1...info12, mo¿na podaæ dodatkowe informacje o sprzedawanej/wynajmowanej nieruchomo¶ci, samochodzie lub motocyklu.

Parametry info1...info12 nie s± obowi±zkowe.


W przypadku wynajmu nieruchomo¶ci:

Parametr
Typ
Opis
info1
integer
Liczba pokoi. 0 - nie okre¶lono
info2
integer
Liczba ³azienek. 0 - nie okre¶lono
info3
integer
Na którym piêtrze znajduje siê mieszkanie (np. 1, 2, 3) . 0 - Parter, -1 - Nie okre¶lono
info4
integer
Czy jest pod³±czony internet.

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Brak
2 - Jest
3 - Mo¿na pod³±czyæ
info5
integer
Okre¶la czy nieruchomo¶æ mog± wynaj±æ osoby pal±ce.

Dostêpne warto¶ci:
0 - Obojêtnie
1 - Tak
2 - Nie
info6
integer
Dla ilu osób ma byæ wynajêta nieruchomo¶æ.
info7
integer
Metra¿ mieszkania (warto¶æ w m2.)
info8
integer
Kaucja w z³.
info9
integer
Dodatkowe op³aty takie jak np. pr±d, gaz. Kwota w z³.
info10
string
Dzielnica w której znajduje siê nieruchomo¶æ.
info11
string
Ulica przy której po³o¿ona jest nieruchomo¶æ.
info12
string
Od kiedy dostêpne do wynajêcia. Data w formacie YYYY-MM-DD (rok-miesiac-dzieñ)


W przypadku sprzeda¿y nieruchomo¶ci - domu:

Parametr
Typ
Opis
info1
integer
Liczba pokoi. 0 - nie okre¶lono
info2
integer
Liczba ³azienek. 0 - nie okre¶lono
info3
integer
Rodzaj ogrzewania

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Miejskie
2 - Gazowe
3 - Elektryczne
4 - Wêglowe
5 - Olejowe
6 - Inne
info4
integer
Typ budynku:

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Wolnostoj±cy
2 - Bli¼niak
3 - Kamienica
4 - Willa
5 - Szeregowy
6 - Inny
info5
integer
Liczba piêter. 0 - nie okre¶lono, 1 - dom parterowy
info6
integer
Materia³ jaki zastosowano do budowy.

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Ceg³a
2 - Pustak
3 - P³yta
4 - Gazobeton
5 - Bloczki
6 - Drewno
7 - Inny
info7
integer
Metra¿ (warto¶æ w m2.)
info8
integer
Rok budowy (YYYY, np. 1995)
info10
string
Dzielnica w której znajduje siê nieruchomo¶æ.
info11
string
Ulica przy której po³o¿ona jest nieruchomo¶æ.


W przypadku sprzeda¿y nieruchomo¶ci - mieszkania:

Parametr
Typ
Opis
info1
integer
Liczba pokoi. 0 - nie okre¶lono
info2
integer
Liczba ³azienek. 0 - nie okre¶lono
info3
integer
Rodzaj ogrzewania

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Miejskie
2 - Gazowe
3 - Elektryczne
4 - Wêglowe
5 - Olejowe
6 - Inne
info4
integer
Na którym piêtrze znajduje siê mieszkanie (np. 1, 2, 3) . 0 - Parter, -1 - Nie okre¶lono
info5
integer
Okre¶la materia³ jaki zastosowano do budowy.

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Ceg³a
2 - Pustak
3 - P³yta
4 - Gazobeton
5 - Bloczki
6 - Drewno
7 - Inny
info7
integer
Metra¿ mieszkania (warto¶æ w m2.)
info10
string
Dzielnica w której znajduje siê nieruchomo¶æ.
info11
string
Ulica przy której po³o¿ona jest nieruchomo¶æ.


W przypadku samochodu:

Parametr
Typ
Opis
info1
integer
Typ pojazdu

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Sedan/Limuzyna
2 - Hatchback
3 - Kombi
4 - Van
5 - Kabriolet
6 - Suv/Terenowy
7 - Pick-up
8 - Inny
info2
integer
Typ silnika

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Benzyna
2 - Benzyna+Gaz
3 - Diesel
4 - Hybryda
5 - Elektryczny
6 - CNG
7 - Inny
info3
integer
Liczba drzwi

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - 2/3
2 - 4/5
3 - 6/7
info4
integer
Skrzynia biegów

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Manualna
2 - Automatyczna
3 - Pó³automatyczna
info5
integer
Okre¶la czy pojazd uszkodzony. Warto¶ci: 1 - nie, 2 - tak, 0 - nie okre¶lono
info6
integer
Klimatyzacja. Warto¶ci: 1 - jest, 2 - brak, 0 - nie okre¶lono
info7
integer
Rok produkcji samochodu (YYYY, np. 2014). 0 - Nie okre¶lono
info8
integer
Pojemno¶æ silnika

Przyk³adowe warto¶ci:
Warto¶æ parametru: 90 - oznacza 0,9 litra
Warto¶æ parametru: 100 - oznacza 1,0 litra
Warto¶æ parametru: 110 - oznacza 1,1 litra
Warto¶æ parametru: 120 - oznacza 1,2 litra
info9
integer
Dotychczasowy przebieg w km


W przypadku motocykla:

Parametr
Typ
Opis
info1
integer
Okre¶la czy motocykl jest uszkodzony. Warto¶ci: 0 - nie okre¶lono, 1 - nie , 2 - tak
info2
integer
Typ silnika

Dostêpne warto¶ci:
0 - Nie okre¶lono
1 - Benzyna
2 - Benzyna+Gaz
3 - Diesel
4 - Hybryda
5 - Elektryczny
6 - CNG
7 - Inny
info7
integer
Rok produkcji (format YYYY, np. 1995). 0 - Nie okre¶lono.
info8
integer
Pojemno¶æ silnika w cm3

Przyk³adowe warto¶ci:
Warto¶æ parametru: 90 - oznacza 90 cm3
Warto¶æ parametru: 100 - oznacza 100 cm3
Warto¶æ parametru: 110 - oznacza 110 cm3
Warto¶æ parametru: 120 - oznacza 120 cm3
info9
integer
Dotychczasowy przebieg w km.
info10
string
Okre¶la wersji konkretnego modelu.
Parametr images:

W parametrze images nale¿y podaæ listê adresów URL ze zdjêciami w formacie JPG. Zdjêcia musz± byæ dostêpne pod wskazanymi adresami URL tak aby nasze interfejs API móg³ je pobraæ. Maksymalny rozmiar pojedyñczego zdjêcia to 2 MB.

Przyk³adowa warto¶æ parametru images zawieraj±ca 2 zdjêcia (JSON):

{"images":["adres_url_do_zdjecia_1.jpg", "adres_url_do_zdjecia_1.jpg"]}


Podaj±c adres do zdjêcia nale¿y podaæ pe³ny adres URL rozpoczynaj±cy sie od http lub https.

Przyk³adowo: http://www.mojadomena.pl/zdjecia/zdjecie1.jpg

Do og³oszeñ standardowych mo¿na dodaæ maksymalnie 2 zdjêcia. Natomiast do og³oszen Premium lub Wyró¿nionych mo¿na dodaæ maksymalnie 10 zdjêæ.



Przyk³ad w jêzyku PHP pokazuj±cy dodanie og³oszenia:

$data = array();
$data['title'] = 'Du¿e mieszkanie do wynajêcia';
$data['description'] = "Do wynajêcia dla 2 osób, dwupokojowe mieszkanie w Krakowie.\r\n";
$data['description'] .= 'Mieszkanie jest ca³kowicie umeblowane niedawno wyremontowane.';
$data['price'] = 2100; // cena w z³

$data['cat1_id'] = 2; // nieruchomo¶ci
$data['cat2_id'] = 24; // wynajem
$data['cat3_id'] = 97; // mieszkania

$data['ad_sell'] = 1;
$data['city_id'] = 2; // Kraków

$data['telephone'] = 5012012013;
$data['contact_name'] = 'Jan Kowalski';

$data['ad_type'] = 1; // og³oszenie standardowe
$data['auto_renewal'] = 0;
$data['extra_info'] = array();
$data['extra_info']['info1'] = 2; // dwupokojowe
$data['extra_info']['info2'] = 1; // jedna ³azienka
$data['extra_info']['info3'] = 4; // piêtro
$data['extra_info']['info4'] = 2; // internet
$data['extra_info']['info5'] = 0; // dla pal±cych
$data['extra_info']['info6'] = 2; // dla 2 osob
$data['extra_info']['info7'] = 52; // metra¿ - 52m kw
$data['extra_info']['info8'] = 1200; // kaucja w z³
$data['extra_info']['info9'] = 1000; // dodatowe oplaty w z³
$data['extra_info']['info10'] = 'Stare miasto'; // dzielnica
$data['extra_info']['info11'] = 'Garncarska'; // ulica
$data['extra_info']['info12'] = '2019-03-21'; // wolne od

$data = json_encode($data);

$api_key = 'TWOJ-KLUCZ-API'; // wpisz tutaj swój klucz API
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('data' => $data)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);
$response = json_decode($response);

if ($response->status == 'ok') echo 'ID dodanego og³oszenia to: '.$response->data->id;
else if ($response->status == 'error') echo 'Wyst±pi³ problem podczas dodawania og³oszenia: '.$response->message;


W przypadku prawid³owego dodania og³oszenia otrzymamy odpowied¼ w formacie JSON, gdzie pole status zawieraæ bêdzie ok. Dodatkowo w odpowiedzi zostanie przes³ane ID og³oszenia, które zosta³o dodane.

ID to nale¿y zachowaæ poniewa¿ bêdzie ono potrzebne gdyby¶my chcieli zmodyfikowaæ og³oszenie lub je usun±æ.

Przyk³adowa odpowied¼ po poprawnym dodaniu og³oszenia (ID nowego og³oszenia to 123456):

{"status":"ok", "message":"Og³oszenie zosta³o dodane", "data":{"id":"123456"}}

W przypadku b³êdu pole status zawieraæ bêdzie warto¶æ error a w polu message podany bêdzie komunikat o b³êdzie.

Przyk³ad pokazuj±cy dodanie tego samego og³oszenia przy wykorzystaniu biblioteki CURL:

curl -H 'API-Key: TWOJ-KLUCZ-API' --data 'data={"title":"Du\u017ce mieszkanie do wynaj\u0119cia","description":"Do wynaj\u0119cia dla 2 os\u00f3b, dwupokojowe mieszkanie w Krakowie.\r\nMieszkanie jest ca\u0142kowicie umeblowane niedawno wyremontowane.", "price":2100, "cat1_id":2, "cat2_id":24, "cat3_id":97, "ad_sell":1, "city_id":2, "telephone":5012012013, "contact_name":"Jan Kowalski", "ad_type":1, "auto_renewal":0, "extra_info":{"info1":2, "info2":1,"info3":4, "info4":2,"info5":0, "info6":2, "info7":52, "info8":1200, "info9":1000, "info10":"Stare miasto", "info11":"Garncarska", "info12":"2019-03-21"}}' https://api.oglaszamy24.pl/api/adverts

Pobieranie listy kategorii
W celu pobrania listy kategorii nale¿y wys³aæ zapytanie GET pod adres:

https://api.oglaszamy24.pl/api/categories


W odpowiedzi otrzymamy listê dostêpnych kategorii oraz podkategorii wraz z parametrami cat1_id, cat2_id, cat3_id.

Przyk³ad z u¿yciem biblioteki CURL.

curl -X GET -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/categories
Pobieranie listy miast
W celu pobrania listy kategorii nale¿y wys³aæ zapytanie GET pod adres:

https://api.oglaszamy24.pl/api/cities

W odpowiedzi otrzymamy listê dostêpnych miast do których mo¿na dodaæ og³oszenia wraz z ID miasta (parametr city_id).

Przyk³ad z u¿yciem biblioteki CURL:

curl -X GET -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/cities


Standardowo wszystkie og³oszenia dodawane za pomoc± API zamieszczane s± na okres 2 tygodni. Wcze¶niejsze usuniêcie og³oszenia mo¿liwe jest za pomoc± odpowiedniej komendy API.
Jak dodaæ og³oszenie Premium lub Wyró¿nione?
W celu dodania og³oszenia Premium lub Wyró¿nionego za pomoc± API nale¿y uprzednio posiadaæ odpowiedni pakiet og³oszeñ a nastêpnie dodaj±c og³oszenie z u¿yciem API w paramerze ad_type nale¿y przes³aæ warto¶æ: 2 - je¿eli chcemy dodaæ og³oszenie Wyró¿nione - lub 3 je¿eli chcemy dodaæ og³oszenie Premium.
Jak dodaæ zdjêcia do og³oszenia?
Istniej± dwie metody dodania zdjêæ do og³oszenia.
  • Pierwsza metoda polega na przes³aniu listy adresów URL, pod którymi dostêpne s± zdjêcia.
  • Druga metoda polega na bezpo¶rednim przes³aniu plików ze zdjêciami na adres serwera API.
W obydwu metodach zdjêcia powinny byæ w formacie JPG, a maksymalny rozmiar pojedyñczego zdjêcia to 2 MB.


1. Metoda pierwsza - przes³anie listy zdjêæ.

W celu dodania zdjêæ do og³oszenia nale¿y przes³aæ zapytanie metod± POST pod adres URL:

https://api.oglaszamy24.pl/api/adverts/{id_ogloszenia}/images


gdzie {id_ogloszenia} to ID og³oszenia do którego chcemy dodaæ zdjêcia.

Zapytanie musi zawieraæ parametr POST "data" z danymi zakodowanymi w formacie JSON.

W parametrze POST data nale¿y przes³aæ zmienn± images zawieraj±c± listê adresów URL ze zdjêciami w formacie JPG. Zdjêcia musz± byæ dostêpne pod wskazanymi adresami URL tak aby nasze interfejs API móg³ je pobraæ. Maksymalny rozmiar pojedyñczego zdjêcia to 2 MB.

Przyk³adowa warto¶æ parametru images zawieraj±ca 2 zdjêcia:

{"images":["adres_url_do_zdjecia1.jpg", "adres_url_do_zdjecia2.jpg"]}

Podaj±c adres do zdjêcia nale¿y podaæ pe³ny adres URL rozpoczynaj±cy sie od http lub https.

Przyk³adowo: http://www.mojadomena.pl/zdjecia/zdjecie1.jpg

Do og³oszeñ bezp³atnych mo¿na dodaæ maksymalnie 2 zdjêcia. Natomiast do og³oszen Premium lub Wyró¿nionych mo¿na dodaæ maksymalnie 10 zdjêæ.

Przyk³ad dla jêzyka PHP:

$api_key = 'TWOJ-KLUCZ-API';
$id = 12345;// ID ogloszenia
$data['images'] = array( 'http://www.mojadomena.pl/zdjecie1.jpg', 'http://www.mojadomena.pl/zdjecie2.jpg' );
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts/'. $id. '/images');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('data' => json_encode($data))));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);



2. Druga metoda - przes³anie plików ze zdjêciami.

W celu dodania zdjêæ do og³oszenia nale¿y przes³aæ zapytanie metod± POST pod adres URL:

https://api.oglaszamy24.pl/api/adverts/{id_ogloszenia}/images/upload

gdzie {id_ogloszenia} to ID og³oszenia do którego chcemy dodaæ zdjêcia.

W parametrze POST data nale¿y przes³aæ plik ze zdjêciem w formacje JPG.

Przyk³ad z wykorzystaniem biblioteki CURL:

curl -H 'API-Key: TWOJ-KLUCZ-API' -F 'data=@/home/images/zdjecie1.jpg' https://api.oglaszamy24.pl/api/adverts/12345/images/upload


Aby dodaæ kilka zdjêæ do og³oszenia nale¿y wys³aæ osobne zapytania dla ka¿dego zdjêcia.

W przypadku porawnego dodania zdjêcia w odpowiedzi pole status zawieraæ bêdzie warto¶æ ok. Natomiast w przypadku b³êdu pole status przyjmie warto¶æ error a w polu message zawarta bêdzie wiadomo¶æ z b³êdem.

Przyk³adowa poprawna odpowied¼:
{"status":"ok", "message":"Zdjêcie zosta³o dodane."}
Wy¶wietlenie listy zdjêæ dodanych do og³oszenia
W celu otrzymania listy zdjêæ, które zosta³y dodane do og³oszenia, nale¿y wys³aæ zapytanie metod± GET pod adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}/images


W odpowiedzi otrzymamy listê ID zdjêæ.

Przyk³adowe zapytanie by otrzymaæ listê zdjêæ dodanych do og³oszenia o ID 12345 z u¿yciem biblioteki CURL:

curl -X GET -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/adverts/12345/images


Powy¿szy przyk³ad dla jêzyka PHP:

$api_key = 'TWOJ-KLUCZ-API';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts/12345/images');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);
Wy¶wietlenie zdjêcia dodanego do og³oszenia
W celu wy¶wietlenia konkretnego zdjêcia nale¿y wys³aæ zapytanie metod± GET pod adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}/images/{id_zdjêcia}

W odpowiedzi wy¶wietlone zostanie zdjêcie w formacie JPG.
Usuniêcie pojedyñczego zdjêcia
W celu usuniêcia pojedyñczego zdjêcia, nale¿y wys³aæ zapytanie metod± DELETE pod adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}/images/{id_zdjecia}

Przyk³adowe usuniêcie zdjêcia o ID 789 z og³oszenia o ID 12345 przy u¿yciu biblioteki CURL.

curl -X DELETE -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/adverts/12345/images/789

Powy¿szy przyk³ad dla jêzyka PHP:

$api_key = 'TWOJ-KLUCZ-API';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts/12345/images/789');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);

W odpowiedzi poprawnego usuniêcia zdjêcia w odpowiedzi serwer powinien zwróciæ nastêpuj±c± odpowied¼:

{"status":"ok","message":" Zdjêcie zosta³o usuniête."}

W przypadku b³êdu zostanie zwrócona odpowied¼ z komunikatem o b³êdzie.
Usuniêcie wszystkich zdjêæ z og³oszenia
W celu usuniêcia wszystkich zdjêæ z og³oszenia, nale¿y wys³aæ zapytanie metod± DELETE pod adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}/images

Przyk³adowe usuniêcie wszystkich zdjêæ z og³oszenia o ID 12345 przy u¿yciu biblioteki CURL.

curl -X DELETE -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/adverts/12345/images

Powy¿szy przyk³ad dla jêzyka PHP:

$api_key = 'TWOJ-KLUCZ-API';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts/12345/images');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);

W odpowiedzi poprawnego usuniêcia zdjêcia w odpowiedzi serwer powinien zwróciæ nastêpuj±c± odpowied¼:

{"status":"ok","message":" Zdjêcia zosta³y usuniête."}

W przypadku b³êdu zostanie zwrócona odpowied¼ z komunikatem o b³êdzie.
Edycja og³oszenia
W celu edycji og³oszenia za pomoc± API nale¿y wys³aæ dane og³oszenia zakodowane w formacie JSON (kodowanie znaków w UTF-8).

Dane musz± zostaæ przes³ane za pomoc± metody PUT jako parametr "data" na adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}

Gdzie {id_og³oszenia} to ID og³oszenia, które chcemy zmodyfikowaæ.

Dane og³oszenia przesy³ane jako parametr data s± takie same jak w przypadku dodawania og³oszenia.

Je¿eli chcesz zaktualizowaæ zdjêcia do og³oszenia, nale¿y usun±æ uprzednio dodane zdjêcia za pomoc± odpowiedniej komendy API.
Usuniêcie og³oszenia
W celu usuniêcia og³oszenia, nale¿y wys³aæ zapytanie metod± DELETE pod adres:

https://api.oglaszamy24.pl/api/adverts/{id_og³oszenia}

Przyk³adowe usuniêcie og³oszenia o ID 12345 przy u¿yciu biblioteki CURL.

curl -X DELETE -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/adverts/12345

Powy¿szy przyk³ad dla jêzyka PHP:

$api_key = 'TWOJ-KLUCZ-API';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.oglaszamy24.pl/api/adverts/12345');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('API-Key: '.$api_key));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close ($ch);

W odpowiedzi , w przypadku poprawnego wykonania zapytania serwer powinien zwróciæ nastêpuj±c± odpowied¼:

{"status":"ok", "message":"Og³oszenie zosta³o usuniête."}

W przypadku b³êdu zostanie zwrócona odpowied¼ z komunikatem o b³êdzie.
Sprawdzenie limitu konta
W celu sprawdzenia ile jeszcze og³oszeñ mo¿emy dodaæ poprzez API, nale¿y wys³aæ zapytanie metod± GET pod adres:

https://api.oglaszamy24.pl/api/account

Przyk³adowe zapytanie przy u¿yciu biblioteki CURL.

curl -X GET -H 'API-Key: TWOJ-KLUCZ-API' https://api.oglaszamy24.pl/api/account

W odpowiedzi, w przypadku poprawnego wykonania, serwer zwróci odpowied¼ w formacje JSON, gdzie zmienna balance_standard, zawieraæ bêdzie ilo¶æ standardowych og³oszeñ, które mo¿emy jeszcze dodaæ bez do³adowywania konta. Ponadto odpowied¼ zawieraæ bêdzie pola balance_bold - ilo¶æ og³oszeñ wyró¿nionych, które mo¿emy dodaæ oraz balance_premium - ilo¶æ og³oszeñ premium, które mo¿emy dodaæ.

Przyk³adowa odpowied¼:

{"balance_standard":"175", "balance_bold":"0", "balance_premium":"15"}

Co oznacza, i¿ nasze saldo na koncie pozwala na dodanie jeszcze 175 og³oszeñ, a po przekroczeniu tego limitu konieczne bêdzie jego zwiêkszenie.
Jak zwiêkszyæ limit API dla konta?
W celu zwiêkszenia limitu API przejd¼ na stronê swojego konta.


Je¿eli masz dodatkowe pytania lub chcesz podzieliæ siê uwagami - skontaktuj siê z nami.


© 2026 Oglaszamy24.pl | API | Wersja pe³na
Zielona-gora.Oglaszamy24.pl - Darmowe og³oszenia Zielona Góra. Dodaj bezp³atne og³oszenia drobne!