API instrukcja

Uwaga! Integracja z API jest w trakcie budowy. Jeśli masz jakieś sugestie lub pytania prosimy o kontakt z administratorem serwisu

Aby móc wykonywać zapytania do API naszego systemu należy mieć zarejestrowane konto oraz włączone API w ustawieniach: https://zaradnypolak.eu/ustawienia
Klucz API musi zawierać dokładnie 32 znaki i nie powinień być udostępniany osobom postronnym.

Zapytania do API należy wykonywać metodą POST lub GET na adres https://zaradnypolak.eu/api

Wymagane zmienne w tablicy to:

user_id - ID użytkownika pobrany z ustawień: https://zaradnypolak.eu/ustawienia
hash - stworzony metodą PHP hash('sha256', $code); gdzie jako $code są połączone wartości wszystkich zmiennych które przesyłamy metodą GET lub POST (klucze są ułożone alfabetycznie) plus na koncu dodany klucz API danego użytkownika pobrany z ustawień
Przykład w PHP:
$user_id=10; $action="show_offer"; $offer_id=5 a klucz API to ABC123
$code = "show_offer".5.10."ABC123"; // klucze ułożone alfabetycznie
$hash = hash('sha256', "show_offer".5.10."ABC123");
action - nazwa akcji do wykonania

Dostępne akcje:

"show_offer" - wyświetla w formacie JSON dane aktywnego ogłoszenia. Wymagany dodatkowy parametr "offer_id" którego wartością powinno być ID ogłoszenia w systemie
"list_offers" - wyświetla listę ogłoszeń w formacie JSON. Naraz wyświetla maksymalnie 100 ogłoszeń. Przekazując dodatkowy parametr "page" możemy określić którą stronę paginacji ma wyświetlać (domyślnie 1)
"list_my_offers" - wyświetla listę ogłoszeń danego użytkownika w formacie JSON. Naraz wyświetla maksymalnie 100 ogłoszeń. Przekazując dodatkowy parametr "page" możemy określić którą stronę paginacji ma wyświetlać (domyślnie 1)
"add_offer" - umożliwia dodanie ogłoszenia.
Wymagane zmienne w request:
- "name" - tytuł ogłoszenia
- "type_id" - ID typu ogłoszeia
- "category_id" - ID kategorii
- "description" - opis ogłoszenia
- "country_id" - ID kraju
- "state_id" - ID regionu
- "state2_id" - ID miasta
Opcjonalne zmienne w request:
- "phone" - numer telefonu
- "address" - adres
- "address_lat" - szerokość geograficzna
- "address_long" - długość geograficzna
- "price" - cena
- "currency" - waluta
- "price_negotiate" - cena do negocacji
- "price_free" - za darmo
W przypadku błędu zostanie zwrócona zmienna "error" z opisem problemu. W przypadku powodzenia zostaną zwrócone zmienne "success" oraz "offer_id" z ID dodanego ogłoszenia
"edit_offer" - edycja ogłoszenia. Wymagane i opcjonalne pola takie same jak przy dodawaniu ogłoszenia. Dodatkowe wymagane pole to "offer_id" z ID ogłoszenia do edycji. W przypadku powodzenia zostanie zwrócona zmienna "success". Można jedynie edytować ogłoszenia danego użytkownika
"remove_offer" - usuwanie ogłoszenia. Wymagane pole to "offer_id" z ID ogłoszenia. Można jedynie usunąć ogłoszenie danego użytkownika
"list_types" - wyświetla listę typów w formacie JSON
"list_categories" - wyświetla listę kategorii w formacie JSON. Opcjonalny parametr to "category_id" którego wartością jest ID nadrzędnej kategorii. Domyślnie jest to 0 (wyświetlają się główne kategorie z systemu)
"list_countries" - wyświetla listę krajów w formacie JSON
"list_states" - wyświetla listę regionów w formacie JSON. Wymagany parametr to "country_id" z ID kraju. Opcjonalny parametr to "state_id" z ID regionu (wyświetlą się wtedy podregiony - miasta - z danego regionu). System posiada 1 poziom kraju i 2 poziomy regionów