Integracja ze stronami WWW

Owned by Michał Fryska
Last updated: Dec 06, 2023
2 min read

Katalog SOWA OPAC może udostępniać zewnętrznym stronom WWW (lub np. urządzeniom multimedialnym) informacje pozwalające na integrację wybranych usług. Jest to “uproszczone API”, które daje dostęp tylko do wycinka danych, jednak jego wykorzystanie jest bardzo proste i pozwala szybko zbudować gotowe rozwiązanie. Dane są zwracane w formacie JSON (zob. https://www.json.org), który jest uznanym standardem wymiany danych między systemami.

Aktualnie “uproszczone API” pozwala na pobieranie:

  • kolekcji “nowości” w katalogu

  • rankingów najpoczytniejszych książek w katalogu

Dla każdej książki należącej do w/w grup (lub też ogólniej - każdego opisu dokumentu) pozwala na pobranie:

  • informacji o tytule i autorze dokumentu

  • adresu URL do strony katalogu OPAC z pełną informacją o dokumencie

  • adresu URL do miniatury okładki (o ile została przez bibliotekarzy do niego dołączona w systemie)

W wywołaniach “uproszczonego API” posługujemy się wartością <cat-id> - jest to identyfikator wybranej bazy w obrębie domeny (gdyż biblioteka może posiadać kilka baz katalogowych!). W większości przypadków będzie to wartość 0 (zero), niemniej w niektórych instalacjach może to być inna wartość - dlatego bibliotekę, która planuje skorzystać z możliwości niniejszego API, prosimy o kontakt na portalu wsparcia, w celu uzyskania informacji o tym identyfikatorze.

Pobieranie kolekcji nowości

Kolekcja nowości dostępna jest pod ścieżką: /api/<cat-id>/collections/news.json (przykładowy adres w katalogu demo - https://www.strix.sowa.pl/api/0/collections/news.json).

Zwracane są wartości:

  • rec_no - identyfikator rekordu logicznego w systemie SOWA

  • title - tytuł dokumentu

  • author - autor dokumentu

  • title_statement - opis skrócony (pobierany z pola 245), do prezentacji

  • ref - numer referencyjny dokumentu (pole 001)

  • url - adres URL do strony katalog OPAC dla tego dokumentu

  • cover - (opcjonalnie) - adres URL do miniatory okładki

Wywołanie można sparametryzować argumentem size, który określa liczbę zwracanych pozycji (domyślnie: 10). Np: pobranie tylko 3 pozycji - https://www.strix.sowa.pl/api/0/collections/news.json?size=3

Pobieranie najpoczytniejszych książek

Rankingi dostępne są pod ścieżką: /api/<cat-id>/rankings/loans/<range>.json, gdzie jako <range> określamy jaki zakres czasowy rankingu ma zostać zwrócony.

Dostępne są 3 zakresy:

Zwracane są wartości takie jak w przypadku kolekcji nowości, rozszerzone o:

  • count - liczba wypożyczeń pozycji w danym okresie

W przypadku rankingów zawsze pobieranych jest 5 najpoczytniejszych książek dla danego okresu.