Warszawa
Łódź
Dokumentacja API LigaFanów
Wersja 1 · Bez wymaganej autoryzacji
Wprowadzenie
Witamy w dokumentacji API LigaFanów (Wersja 1). Nasze API zostało zaprojektowane, aby dostarczać deweloperom łatwy dostęp do kluczowych danych platformy LigaFanów, umożliwiając pobieranie informacji o ligach, sezonach i drużynach.
Adresy bazowe:
https://ligafanow.pl/api/v1/– dla danych dotyczących rozgrywek w Warszawie.https://lodz.ligafanow.pl/api/v1/– dla danych dotyczących rozgrywek w Łodzi.
Limity żądań: Obecnie API nie ma zdefiniowanych limitów żądań, ale prosimy użytkowników o przestrzeganie zasad uczciwego użytkowania, aby zapewnić wysoką dostępność dla wszystkich. W przyszłości mogą zostać wprowadzone limity żądań, o czym poinformujemy z wyprzedzeniem.
Kontakt i wsparcie: W przypadku pytań, problemów lub sugestii prosimy o kontakt poprzez e-mail: kontakt@ligafanow.pl.
Autoryzacja
API LigaFanów w wersji 1 jest w pełni publiczne i nie wymaga autoryzacji. Wszystkie punkty końcowe są dostępne bez konieczności stosowania kluczy API, tokenów czy innych form uwierzytelniania. Taki model dostępu ułatwia integrację i testowanie, umożliwiając deweloperom szybkie rozpoczęcie pracy. Prosimy jednak o przestrzeganie zasad uczciwego użytkowania, aby zapewnić wysoką dostępność i wydajność API dla wszystkich użytkowników.
Błędy
API LigaFanów zwraca standardowe kody błędów HTTP w przypadku niepowodzenia żądania. Poniżej znajduje się lista najczęściej występujących kodów błędów wraz z ich opisami.
Kody błędów
| Kod HTTP | Opis |
|---|---|
400 |
Błędne żądanie – żądanie zawiera nieprawidłowe parametry lub niepoprawną składnię. |
404 |
Nie znaleziono – zasób, np. liga, sezon lub drużyna, nie istnieje lub jest niedostępny. |
429 |
Zbyt wiele żądań – przekroczono limit żądań w danej jednostce czasu. |
500 |
Błąd serwera – wystąpił nieoczekiwany problem po stronie serwera. |
Metody API
Wersja 1 · Bez wymaganej autoryzacji
Przegląd
Ten punkt końcowy umożliwia pobranie listy wszystkich dostępnych lig w systemie LigaFanów. Odpowiedź zawiera identyfikatory lig oraz ich nazwy, co pozwala na łatwe przeglądanie dostępnych rozgrywek. Dane są zwracane w formacie JSON, co ułatwia integrację z aplikacjami.
Szczegóły żądania
URL: https://ligafanow.pl/api/v1/leagues
Metoda: GET
Parametry URL: Brak
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status |
ciąg znaków | Wskazuje status odpowiedzi (np. "success"). |
code |
liczba całkowita | Kod statusu HTTP odpowiedzi (np. 200 dla sukcesu). |
data |
tablica obiektów | Lista lig dostępnych w systemie. |
data[].league_id |
liczba całkowita | Unikalny identyfikator ligi. |
data[].league_name |
ciąg znaków | Nazwa ligi (np. "Ekstraklasa"). |
Przegląd
Ten punkt końcowy umożliwia pobranie aktualnej tabeli dla ligi określonej przez identyfikator {league_id}. Odpowiedź zawiera szczegółowe informacje o każdej drużynie, w tym jej pozycję, statystyki meczowe oraz dane takie jak logo i nazwa drużyny. Dane są zwracane w formacie JSON, co ułatwia ich integrację z aplikacjami.
Szczegóły żądania
URL: https://ligafanow.pl/api/v1/table/{league_id}
Metoda: GET
Parametry URL:
| Nazwa | Typ | Opis |
|---|---|---|
league_id |
liczba całkowita | Wymagany. Identyfikator ligi, dla której pobierana jest tabela (np. 123). |
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status |
ciąg znaków | Wskazuje status odpowiedzi (np. "success"). |
code |
liczba całkowita | Kod statusu HTTP odpowiedzi (np. 200 dla sukcesu). |
data |
tablica obiektów | Lista drużyn w tabeli ligi, posortowana według pozycji. |
data[].team_id |
liczba całkowita | Unikalny identyfikator drużyny. |
data[].team_name |
ciąg znaków | Nazwa drużyny. |
data[].logo |
ciąg znaków | Adres URL do logo drużyny. |
data[].position |
liczba całkowita | Pozycja drużyny w tabeli. |
data[].statistics |
obiekt | Statystyki drużyny w lidze. |
data[].statistics.matches |
liczba całkowita | Liczba rozegranych meczów. |
data[].statistics.wins |
liczba całkowita | Liczba zwycięstw. |
data[].statistics.draws |
liczba całkowita | Liczba remisów. |
data[].statistics.losses |
liczba całkowita | Liczba porażek. |
data[].statistics.goals_scored |
liczba całkowita | Liczba strzelonych goli. |
data[].statistics.goals_conceded |
liczba całkowita | Liczba straconych goli. |
data[].statistics.goal_difference |
liczba całkowita | Różnica bramek (strzelone minus stracone). |
data[].statistics.forfeits |
liczba całkowita | Liczba walkowerów. |
data[].statistics.points |
liczba całkowita | Liczba zdobytych punktów. |
Przegląd
Ten punkt końcowy umożliwia pobranie szczegółowych informacji o konkretnej drużynie na podstawie jej identyfikatora {alias}. ( taki sam jak adres url drużyny ) Odpowiedź zawiera m.in. dane klubowe, projektowe, listę zawodników podzieloną na grupy, listę meczów oraz zbiorcze statystyki zespołu.
Szczegóły żądania
URL: https://ligafanow.pl/api/v1/team/{alias}
Wskazówka: Alias drużyny (np. q-ice-warszawa) możesz łatwo sprawdzić, wchodząc na profil danej drużyny na stronie serwisu.
Przykładowy link w serwisie: https://ligafanow.pl/statystyki/druzyna/q-ice-warszawa
Wygląd docelowego linku do API: https://ligafanow.pl/api/v1/team/q-ice-warszawa
Metoda: GET
Parametry URL:
| Nazwa | Typ | Opis |
|---|---|---|
id |
liczba całkowita | Wymagany. Unikalny identyfikator drużyny w systemie. |
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status |
ciąg znaków | Status odpowiedzi (np. "success"). |
code |
liczba całkowita | Kod statusu HTTP (np. 200). |
data.id |
liczba całkowita | Identyfikator zespołu. |
data.name |
ciąg znaków | Pełna nazwa drużyny (np. "Mareckie Wygi"). |
data.short_name / middle_name |
ciąg znaków | Skrócona lub członowa nazwa drużyny. |
data.alias |
ciąg znaków | Przyjazny adres URL drużyny. |
data.logo / shirt |
ciąg znaków | Adresy URL do logotypu oraz koszulki drużyny. |
data.club |
obiekt | Szczegółowe dane macierzystego klubu (kraj, logo w różnych rozmiarach). |
data.project |
obiekt | Informacje o rozgrywkach/sezonie (np. nazwa ligi, identyfikator projektu, pozycja w tabeli). |
data.players |
obiekt | Zbiór grup zawodników przypisanych do zespołu (zawierający tablicę items ze strukturą stats dla każdego gracza: id, imię, nazwisko, awatar, flaga kraju, wiek). |
data.matches |
tablica obiektów | Historia i harmonogram meczów drużyny (zawiera daty, wyniki, dane rywali, boiska oraz sędziów). |
data.stats |
obiekt | Zbiorcze statystyki zespołu (liczba meczów, wygrane, bramki zdobyte/stracone, żółte/czerwone kartki, trofea i punkty). |