PBN Rest API

API (Application Programming Interface) to interfejs programistyczny aplikacji, który w ramach systemu PBN umożliwia pobieranie informacji o czasopismach, publikacjach jednostki, publikacjach osoby i tak dalej. Za jego pośrednictwem możliwe jest też dodawanie publikacji do Modułu Sprawozdawczego PBN.

Dostęp do PBN API możliwy jest z menu bocznego (1). Dokumentacja i informacje o pełnym zakresie usług dostępne są w zakładce API, po kliknięciu na „Przejdź do dokumentacji” (2).

Klucz API

Do niektórych funkcjonalności API potrzebny jest klucz identyfikujący, który jest udostępniany wyłącznie zalogowanym użytkownikom z rolą Importera Publikacji. Na pasku bocznym widzą oni dodatkowe okienko „Dostęp dla twojej instytucji”, które umożliwia dostęp do klucza. Należy zwrócić uwagę, że klucz jest przypisany do jednostki naukowej a nie do Importera Publikacji - obowiązuje jeden klucz dla całej jednostki. Jednocześnie klucz identyfikuje jednostkę dla API.

Klucz można wygenerować samodzielnie w zakładce API po kliknięciu w przycisk „Uzyskaj dostęp dla swojej instytucji” (3) (opcja samodzielnego generowanie klucza API dostępna niebawem!).

Samodzielne generowanie klucza API na wersji produkcyjnej systemu

Samodzielne generowanie klucza API w wersji przedstawionej na zrzucie ekranu dostępne będzie niebawem (planowana data wdrożenia - druga połowa lipca 2018 r.). Tymczasem można dostać się do produkcyjnego klucza API poprzez adres URL. Wystarczy będąc zalogowanym do nowej Aplikacji Importerem Publikacji wkleić https://pbn-ms.opi.org.pl/pbn-report-web/pages/developer/institution w pasek adresu przeglądarki. System wyświetli produkcyjny klucz API dla jednostki w kontekście której pracował w danym momencie Importer.

Uwaga! Od 12 czerwca 2018 r.: W celu zwiększenia ochrony danych zawartych w systemie, klucz udostępniany Importerom Publikacji wymaga dodatkowego przetworzenia aby mógł skutecznie autoryzować dostęp do API.

Jak dostosować klucz do wymagań API PBN?

  1. Wygeneruj klucz API
  2. Dodaj do niego godzinę i datę w formacie HHddMMYYYY (np dla godz. 8:35 w dniu 7 czerwca 2018 roku dodajemy „0807062018”)
  3. użyj funkcji hashujacej sha1 do zakodowania klucza z doklejoną godziną i datą

Tak przygotowana wartość będzie autoryzowała dostęp do API PBN.

Uwaga! Tak przygotowany klucz ważny jest przez godzinę.

Lista usług

KategoriaTypOpis Czy klucz jest wymagany?
searchGETPobierz listę publikacji dla osoby (po PBN-ID)/jsonTAK
searchGETPobierz listę publikacji dla osoby (po PBN-ID)/xmlTAK
searchGETPobierz listę publikacji dla instytucji/jsonTAK
searchGETPobierz listę publikacji dla instytucji/xmlTAK
searchGETPobierz listę publikacji dla zapytania/jsonTAK
searchGETPobierz listę publikacji dla zapytania/xmlTAK
institutionGETPobierz listę instytucji sprawozdających/jsonNIE
doajPOSTDodaj artykuł (zgodne z DOAJ Json)TAK
doajGETPobierz artykuł (zgodne z DOAJ Json)TAK
doajPUTZaktualizuj artykuł (zgodne z DOAJ Json)TAK
doajDELETEUsuń artykuł (zgodne z DOAJ Json)TAK
importPOSTPrzekaż plik XML do kolejki importuTAK
importGETSprawdź status importuTAK
journalGETPobierz listę czasopismTAK
journalGETPobierz informacje o czasopismach po ISSN/eISSNTAK
CRUDGETPobierz publikacjęTAK
CRUDHEADPobierz informacje o ilości publikacji i stron dla zapytania, dla instytucjiTAK
CRUDGETPobierz listę publikacji dla instytucjiTAK
CRUDHEADPobierz nagłówek publikacjiTAK
CRUDPOSTUtwórz publikacjęTAK
CRUDPOSTUtwórz publikacjęTAK
CRUDPUTUtwórz/modyfikuj publikacjęTAK
CRUDDELETEUsuń publikacjęTAK
oaipmhGETKońcówka dla OAI-PMHNIE
contributorGETPobierz informacje o osobach po PESEL/POL-on UIDTAK
apiGETSprawdź limit wywołań dla twojego klucza APITAK
usersGETZaloguj osobę o podanym adresie e-mail (do API)NIE

Dokumentacja API PBN

Specyfikacja publicznego API PBN w formacie JSON