Fundusze Europejskie

Web API Aleksandrów Łódzki

Liczba wizyt: 54

System udostępnia Web API znajdujące się pod adresem:
aleksandrow-lodzki.pl/wp-json/custom-api.

Opis metod

Serwis zawiera następujące metody:

  • metoda zwracająca listę artykułów udostępnionych w systemie
    Metoda typu GET
    Adres:
    posts/<post-type> page=<page>&posts_per_page=<posts_per_page>&category=<category>
    Parametry:

    • post-type – rodzaj wpisu. W systemie znajdują się następujące rodzaje wpisów:
      • location – Lokalizacja,
      • event – Wydarzenia,
      • wykazy – Wykazy,
      • zapytania-ofertowe – Zapytania Ofertowe,
      • zamowienia-publiczne – Zamówienia Publiczne,
      • przetargisprzedaz – Przetargi – sprzedaż nieruchomości,
      • informator – Informator,
      • fundusze-unijne – Fundusze Unijne,
      • post – Wpisy (wartość domyślna),
    • page – numer strony(numeracja przebiega od liczby 0),
    • post_per_page – liczba artykułów jaka będzie znajdować się na jednej stronie(parametr opcjonalny),
    • category – id kategorii, w której należą wpisy(parametr opcjonalny).

    Struktura danych w odpowiedzi:

    • posts – zawiera listę obiektów typu post,
    • pages – zawiera informację o liczbie stron, na których znajdują się artykuły.

    Przykład użycia:
    http://aleksandrow-lodzki.pl/wp-json/custom-api/posts/post?page=1
  • metoda zwracająca listę kategorii utworzonych w systemie
    Metoda typu GET
    Adres:
    system-categories
    Struktura danych w odpowiedzi:

    • Tablica obiektów typu category.

    Przykład użycia:
    http://aleksandrow-lodzki.pl/wp-json/custom-api/system-categories
  • metoda zwracająca dane wybranego wpisu
    Metoda typu GET
    Adres:
    post/
    Parametry:

    • post-id – id artykułu.

    Struktura danych w odpowiedzi:

    • obiekt typu post.

    Przykład użycia:
    http://aleksandrow-lodzki.pl/wp-json/custom-api/post/1706

Struktura dostępnych obiektów

W serwisie wykorzystywane są następujące typy obiektów:

  • post – typ artykułu zawierający następujące własności:
    • ID – identyfikator,
    • post_author – identyfikator autora,
    • post_date – data,
    • post_content – zawartość,
    • post_title – tytuł,
    • post_excerpt – zawartość skrócona,
    • post_name – fragment URL wykorzystywany w przypadku używania przyjaznych adresów URL,
    • post_modified – data ostatniej modyfikacji,
    • post_parent – identyfikator artykułu nadrzędnego,
    • guid – adres URL artykułu,
    • thumbnail – adres URL obrazka wyróżniającego,
    • categories – tablica identyfikatorów kategorii, do których należy danyartykuł,

    W zależności od typu artykułu, obiekt będzie zawierał dodatkowe własności:

    • location:
      • location_address – adres,
      • location_latitude – szerokość geograficzna,
      • location_longitude – długość geograficzna,
      • location_country – kraj,
    • event:
      • location_id – identyfikator lokalizacji,
      • event_start_time – czas rozpoczęcia,
      • event_end_time – czas zakończenia,
      • event_all_day – informacje o tym czy wydarzenie trwa cały dzień (0 = nie, 1 = tak),
      • event_start_date – dzień rozpoczęcia,
      • event_end_date – dzień zakończenia,
    • zamowienia-publiczne:
      • number – numer,
      • domain – dziedzina,
      • attachments – załączniki,
    • informator:
      • address – adres,
      • map – lokalizacja,
      • phone – telefon,
  • category – typ kategorii zawierający następujące własności
    • name – nazwa,
    • slug – fragment URL wykorzystywany w przypadku używania przyjaznychadresów URL,
    • description – opis,
    • parent – identyfikator kategori nadrzędnej,
    • count – liczba artykułów znajdujących się w danej kategorii,
    • cat_ID – identyfikator.

Przykłady zostały zaprezentowane przy użyciu programu postman.

Translate »