Dokumentacja API lewica.pl

API

API lewica.pl składa się w chwili obecnej z trzech skryptów działających na naszym serwerze, które wykorzystują koncepty znane z serwisów internetowych typu REST. Skrypty są dostępne za pośrednictwem standardowych poleceń GET protokołu HTTP, a zwracane dane mogą być manipulowane z użyciem dodatkowych parametrów przekazywanych w adresie URL.

Skrypty API lewica.pl zwracają dane w formacie XML, a tekst jest zakodowany w standardzie UTF-8.

Za pośrednictwem API lewica.pl można uzyskać dostęp do następujących sekcji portalu:

  1. polska
  2. świat
  3. publicystyka
  4. recenzje
  5. kultura
  6. ogłoszenia
  7. kalendarium (historia)

1. Polska, świat, publicystyka, recenzje, kultura

Adres: http://lewica.pl/api/publikacje.php

Parametry

Parametr Wartość domyślna Opis
dzialy 1,2,3,4,5 Lista identyfikatorów kategorii oddzielona przecinkami.
  • 1 - polska
  • 2 - świat
  • 3 - publicystyka
  • 4 - recenzje
  • 5 - kultura
Przykład: dzialy=1,2 dla Polski i Świata.
od Zawęża rezultaty do tekstów z identyfikatorem większym niż podana wartość. Jeśli parametr nie istnieje, zwracane są ostatnie artykuły.
limit 5 Maksymalna lista żądanych artykułów; liczba nie może być większa niż 10.
format XML Format danych. Może mieć wartość XML lub JSONP. W przypadku formatu JSONP pakiet danych jest wywołaniem funkcji JavaScript pod nazwą LewicaPLDataProvider.processJSON_Articles().

Przykłady

http://lewica.pl/api/publikacje.php?dzialy=2&limit=3
- zwraca trzy ostatnie pozycje w dziale "świat".
http://lewica.pl/api/publikacje.php?dzialy=1,2,3,4,5&od=10000&limit=10
- po dziesięć ostatnich pozycji z wszystkich dostępnych działów, zawężając wyniki do tych pozycji, których ID jest większe niż 10000.

Charakterystyka zwracanego pakietu

Jeśli wybrano format XML, pakiet jest umieszczony w głównym węźle publikacje, który zawiera w sobie zero lub więcej węzłów publikacja.

Tabela zawiera charakterystykę znaczników artykułu, które znajdują się wewnątrz węzła publikacja.

Węzeł Opis
id Unikatowy, numeryczny identyfikator publikacji.
id_dzial Unikatowy, numeryczny identyfikator kategorii.
  • 1 - polska
  • 2 - świat
  • 3 - publicystyka
  • 4 - recenzje
  • 5 - kultura
id_autor Unikatowy, numeryczny identyfikator autora publikacji.
Wykorzystywanie tego parametru nie jest zalecane, ponieważ nie udostępniamy w tej chwili mapowania identyfikatorów i nazwisk autorów publikacji.
id_pokrewne Opcjonalna, oddzielona przecinkami lista identyfikatorów publikacji powiązanych tematycznie z treścią danego artykułu.
data Data opublikowania artykułu w formacie YYYY-MM-DD HH:MM:SS
url Pełen adres internetowy publikacji, np. http://lewica.pl/?id=25025
komentarzy Ilość komentarzy czytelników portalu w momencie generowania pakietu XML.
obrazek Opcjonalne rozszerzenie obrazka, o ile jest dostępny dla danej publikacji. Możliwe wartości: png, jpg i gif.
Ścieżki do miniaturek obrazków: /im/thumbs/th_{id}.{obrazek}
Ścieżki do dużych obrazków: /im/th_{id}.{obrazek}
tytul Tytuł publikacji.
tekst Treść publikacji.
opinia Opcjonalny komentarz redakcyjny do artykułów publikowanych w działach "polska" i "świat".

 

2. Ogłoszenia

Adres: http://lewica.pl/api/ogloszenia.php

Parametry

Parametr Wartość domyślna Opis
od Zawęża rezultaty do pozycji z identyfikatorem większym niż podana wartość. Jeśli parametr nie istnieje, zwracane są ostatnie ogłoszenia. Identyfikator jest wartością numeryczną.
limit 10 Maksymalna lista żądanych ogłoszeń; liczba nie może być większa niż 10.

Charakterystyka zwracanego pakietu

Jeśli wybrano format XML, pakiet jest umieszczony w głównym węźle ogloszenia, który zawiera w sobie zero lub więcej węzłów ogloszenie. Każdy węzeł "ogloszenie" posiada szereg atrybutów, które są opisane w tabeli poniżej.

Tabela zawiera charakterystykę znaczników ogłoszenia, które znajdują się wewnątrz węzła ogloszenie.

Węzeł Opis
id Unikatowy, numeryczny identyfikator ogłoszenia.
Jeśli ogłoszenie znajduje się wśród dziesięciu ostatnio dodanych pozycji, możliwe jest zbudowanie linku z kotwicą odwołującą się bezpośrednio do danego ogłoszenia na stronie internetowej lewica.pl. Link powinien mieć postać http://lewica.pl/?s=advert#[id]
co Tytuł ogłoszenia
gdzie Krótka informacja na temat miejsca, w którym odbędzie się wydarzenie. Wartość może być pusta.
kiedy Krótka informacja na temat czasu, w którym odbędzie się wydarzenie. Wartość może być pusta.
opis Treść ogłoszenia.
autor Nazwisko osoby lub nazwa organizacji, która zamieściła ogłoszenie. Wartość może być pusta.
autor_email Adres e-mail osoby lub organizacji, która zamieściła ogłoszenie. Wartość może być pusta.

 

3. Kalendarium

Adres: http://lewica.pl/api/kalendarium.php

Parametry

Parametr Wartość domyślna Opis
dzien dzisiejszy dzień Liczba w przedziale 1-31.
miesiac obecny miesiąc Liczba w przedziale 1-12.
limit 100 Maksymalna lista żądanych pozycji; liczba nie może być większa niż 100.

Charakterystyka zwracanego pakietu

Główny węzeł XML to kalendarium. Zawiera on w sobie zero lub więcej węzłów wydarzenie. Blok wydarzenie składa się z węzłów rok i tytuł.

Przykładowy pakiet
<kalendarium>
	<naglowek>
		<wydawca>lewica.pl</wydawca>
		<miesiac>8</miesiac>
		<dzien>29</dzien>
	</naglowek>
	<wydarzenie>
		<rok>1918</rok>
		<tytul>
		Dekret radzieckiej Rady Komisarzy Ludowych anulował 
		akty rozbiorowe Polski i przyznał Finlandii
		prawo do niepodległości.
		</tytul>
	</wydarzenie>
	<wydarzenie>
		<rok>1944</rok>
		<tytul>Rozpoczęło się Słowackie 
		Powstanie Narodowe.</tytul>
	</wydarzenie>
</kalendarium>

 

RSS

Kanały RSS są odświeżane raz na godzinę i zawierają tylko około 300 początkowych znaków artykułu. Wykorzystywane kodowanie znaków to ISO-8859-2. Wersja RSS, którą używamy, to 2.0.

Subskrypcja kanałów lewica.pl jest możliwa za pośrednictwem rozlicznych czytników RSS, które mogą przybierać postać tradycyjnych aplikacji instalowanych na komputerze, w tym zwykłych przeglądarek internetowych czy programów pocztowych, lub też serwisów on-line. Na stronach Wikipedii znaleźć można listę kilkunastu popularnych czytników RSS.

Kanały RSS lewica.pl

Kategoria Adres
polska http://lewica.pl/polska/rss.xml
świat http://lewica.pl/swiat/rss.xml
publicystyka http://lewica.pl/publicystyka/rss.xml
recenzje http://lewica.pl/recenzje/rss.xml
kultura http://lewica.pl/kultura/rss.xml