Przejdź do treści Przejdź do głównej nawigacji Przejdź do stopki

API

Planowane zmiany w Profilu Instytucji

Zgodnie z wymaganiami Ministerstwa Nauki i Szkolnictwa Wyższego do Profilu Instytucji (PI) powinny być sprawozdawane wszystkie publikacje naukowe uczelni i instytutów – zarówno te, które są przekazywane do ewaluacji jakości działalności naukowej, jak i pozostałe. Stanowisko Ministerstwa dostępne jest pod adresem: https://polon.nauka.gov.pl/aktualnosci/493869.

W PBN zostaną wprowadzone odpowiednie zmiany, których celem jest spełnienie wymagań Ministerstwa. Nowe funkcjonalności pozwolą importerom publikacji na raportowanie publikacji niezgłaszanych do ewaluacji oraz zarządzanie nimi. Razem z nowymi funkcjonalnościami PI uzyska nową szatę graficzną.

Zmiany w PI będą wdrożone w taki sposób, aby uniknąć niepotrzebnej pracy importerów publikacji. Zostanie zachowany dotychczasowy sposób sprawozdawania danych na potrzeby ewaluacji, zarówno poprzez aplikację internetową, jak i API. Wszystkie dane publikacji zaraportowane do tej pory przez importerów będą automatycznie przeniesione do nowego PI.

Wdrożenie nowego PI nastąpi w maju br. i zajmie kilka dni. W tym czasie system PBN będzie niedostępny dla użytkowników. Po określeniu dokładnego terminu wdrożenia zostanie on niezwłocznie opublikowany.

Wraz z wdrożeniem zostaną udostępnione strony pomocy oraz materiały instruktarzowe (nagrania wideo) dotyczące zarządzania publikacjami w nowym PI.

Zmiany dotyczące sprawozdawczości w PBN przyniosą korzyści społeczności akademickiej. Wszystkie publikacje zaraportowane do PI będą automatycznie przesyłane do systemu Ludzie Nauki i prezentowane w profilach poszczególnych naukowców. Ponadto, szerszy zakres danych przekazywanych do PBN pozwoli na prowadzenie pełniejszych kwerend bibliograficznych w tym systemie.

Nowa funkcjonalność API

W dniu 15.01.2024 r. została dodana możliwość filtrowania według zakresu lat dla końcówki https://pbn.nauka.gov.pl/api/#/search-controller/publicationsUsingPOST

Nowa funkcjonalność API

W dniu 17.11.2023 została udostępniona nowa funkcjonalność API. Za pomocą końcówki /v1/person/polon/{uid} jest obecnie możliwe wyszukiwanie metadanych osób nie tylko po UID przypisanym w systemie POL-on do pracownika, ale również po UID przypisanym w tym systemie do doktoranta.

Wdrożenie wersji 23.10.1

W dniu 12.10.2023 r. zaktualizowano system PBN 2.0 do wersji 23.10.1

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu to:

  • prezentowanie kodu dyscypliny w oświadczeniach oraz w raporcie generowanym w zakładce Twoja Jednostka;
  • prezentowanie w raporcie generowanym z w zakładce Twoja Jednostka dodatkowych identyfikatorów osoby: objectId („identyfikator osoby”), uuidPerson („POL-on UUID”).

Najważniejsze modyfikacje API:

  • umożliwienie edycji lub usunięcia wprowadzonego DOI poprzez końcówkę /v1/publications/doi. 

Wdrożenie wersji 23.7.1 oraz 23.7.2

W dniu 19.07.2023 r. zaktualizowano system PBN 2.0 do wersji 23.7.2.

Najważniejsze modyfikacje API wprowadzone we wdrożeniu to:

  • rozszerzenie uprawnienia tokenów do odczytu o możliwości wyszukiwania i pobierania danych za pomocą końcówek search:
    • /v1/institutionProfile/publications/search/fees
    • /v1/institutionProfile/publications/search/incompleted-fees
    • /v1/search/conferences
    • /v1/search/institutions
    • /v1/search/journals
    • /v1/search/publications
    • /v1/search/publishers
    • /v1/search/persons
  • dodanie parametrów umożliwiających pobieranie publikacji z Profilu Autora dla zdefiniowanego przedziału lat (filtrowanie dotyczące roku publikacji)

W dniu 26.06.2023 r. zaktualizowano system PBN 2.0 do wersji 23.7.1.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu to:

  • wprowadzenie walidacji na format daty (wymagana liczba dodatniaa czterocyfrowa) przy dodawaniu obiektów typu publikacja oraz czasopismo,
  • umożliwienie wyszukiwania przy użyciu przycisku „enter” w zakładkach w Profilu Instytucji.

Wdrożenie wersji 23.4.1

Dnia 06.04.2023 r. zaktualizowano moduł PBN do wersji 23.4.1. Najważniejsze modyfikacje obejmują:

  • Wyłączono trwale funkcjonalność Sugestii oświadczeń. Wyłączenie nastąpiło w porozumieniu z MEiN.
  • Wprowadzono alfabetyczne sortowanie list dyscyplin na listach wyboru w komponentach filtrów.

Zmiany w API obejmują:

  • W dokumentacji API (Swagger) dodano nową końcówkę do pobierania słownika dyscyplin: GET​/v2​/dictionary​/disciplines. Jednocześnie stara końcówka została wykreślona. Używanie wykreślonej z dokumentacji końcówki jest nadal możliwe, ale za jej pomocą pobierane są nieaktualne dane.
  • Rozbudowano model danych słownika dyscyplin. Obecnie zwracane są następujące dane:
[
  {
    "disciplines": [
      {
        "code": "string",
        "name": "string",
        "polonCode": "string",
        "scientificFieldName": "string",
        "uuid": "string"
      }
    ],
    "uuid": "string",
    "validityDateFrom": "2023-04-11",
    "validityDateTo": "2023-04-11"
  }
]
  • code – kody dyscypliny w module PBN
  • name – nazwa dyscypliny
  • polonCode – odpowiedni kod dyscypliny w systemie POL-on
  • scientificFieldName – nazwa dziedziny, z której pochodzi dyscyplina
  • uuid – alfanumeryczny kod dyscypliny (uuid)
  • validityDateFrom – data początkowa obowiązywania słownika
  • validityDateTo – data końcowa obowiązywania słownika

Wdrożenie wersji 21.11.1

W dniu 22.11.2021 r.  zaktualizowano system do wersji 21.11.1.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu: 

  • uzupełnienie brakującej punktacji dla czasopism z listy ministerialnej
  • poprawa punktacji dla czasopisma Finance India
  • rozszerzenie raportu xlsx z Profilu Instytucji o ISBN monografii źródłowej oraz Dane do ewaluacji

Najważniejsze modyfikacje API :

Wdrożenie wersji 21.10.1.

W dniu 22.10.2021 r.  zaktualizowano system do wersji 21.10.1.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu: 

  • korekta niepoprawnych zapisów mniswId
  • poprawa błędu logowania dla użytkowników z rolą systemową Przedstawiciel Czasopisma
  • poprawa punktów dla czasopisma Folia Cardiologica (ISSN 2353-7752, e-ISSN 2353-7760)
  • zdjęcie walidacji na stronę internetową serii i edycji konferencji

Najważniejsze modyfikacje API :

  • poprawiono działanie wyszukiwarki /v1/search/publications – umożliwiono wyszukiwanie publikacji po więcej niż jednym autorze
  • umożliwiono nadawanie podmiotom posiadającym token aplikacji odczyt/zapis dodatkowych tokenów tylko do odczytu
  • zdjęto walidację na stronę internetową serii i edycji konferencji
  • dodano do słownika API pozycję ’’Nieznany lub błędny kraj”

Wdrożenie wersji 21.9.2

W dniu 01.10.2021 r.  zaktualizowano system do wersji 21.9.2.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu: 

  • oddano ekspertom narzędzia umożliwiające przeprowadzenie oceny monografii
  • poprawiono błędy na wykazie konferencji  (Wykazy – Oficjalna lista konferencji) – umożliwiono wyszukiwanie po nazwie skróconej oraz pełnej nazwie wraz z nazwą skróconą
  • poprawiono wyszukiwanie na oficjalnych listach ministerialnych w Wykazach – umożliwiono wyszukiwanie za pomocą klawisza ENTER
  • zaktualizowano linki odsyłające do aktualnych list ministerialnych – zmieniono nazwę przycisku na „Pobierz listę ze strony MEiN”
  • w zakładce Wykazy zmieniono nazwę strony z Wydawca na Wydawnictwa
  • zmieniono kolejność wyświetlania informacji na stronie PBN – jako pierwsze wyświetlają się obecnie Aktualności
  • na Profilu Instytucji dla rozdziałów w monografiach usunięto z Danych do ewaluacji pola dotyczące monografii (dane dotyczące edycji naukowej tekstu źródłowego, źródeł finansowania edycji, informacji czy monografia stanowi tłumaczenie)

Najważniejsze modyfikacje API :

  • umożliwiono dodawanie poprzez API roczników, tomów i numerów dla czasopism występujących już w PBN
  • w przypadku przesłania czasopisma o roczniku, tomie i numerze występujących już w PBN dodano w komunikacie objectId objektu występującego już w bazie
  • dla końcówki GET ​/v1​/conferences​/{conferenceId}​/editions dodano w wynikach wyszukiwania objectId edycji

Wdrożenie w dniu 13.09.2021 r.

W dniu 13.09.2021 r.  przeładowano dane w celu poprawnego ich wyświetlania w systemie SEDN.

Dodatkowo w ramach prac wykonano:

  • korektę nazw wydawnictw – Wydawnictwo Poznańskie i Wydawnictwo Pallottinum
  • zaktualizowano listę konferencji

 

Hackathon

Hackathon API PBN

Zaproszenie na hackathon API PBN

06 października 2021

Ośrodek Przetwarzania Informacji – Państwowy Instytut Badawczy zaprasza do udziału w wydarzeniu: Hackathon API Polskiej Bibliografii Naukowej.

Wydarzenie odbędzie się 6 października br. w formule online – na platformie ZOOM oraz z wykorzystaniem bezpłatnego komunikatora internetowego Slack.

Wydarzenie skierowane jest do osób zajmujących się integracją aplikacji Polska Bibliografia Naukowa (PBN) poprzez API w podmiotach szkolnictwa wyższego i nauki.

Wydarzenie podzieliliśmy na dwie części:

Część informacyjna – 06.10.br. w godz. 9:15-9:45, platforma ZOOM.

W trakcie spotkania:

  • przedstawimy krótką prezentację na temat dostępnej dokumentacji API,
  • dokonamy przeglądu dokumentacji zamieszczonej w aplikacji Swagger,
  • zaprezentujemy opis zawartości stron pomocy PBN dotyczący API.

Część konsultacyjna/hackathon – 06.10.br. w godz. 10:00-14:00, bezpłatny komunikator internetowy Slack

Część konsultacyjna odbędzie się na platformie Slack, gdzie nasi konsultanci odpowiedzą na pytania i udzielą wyjaśnień na temat API PBN. Ta szybka ścieżka komunikacji umożliwi:

  • rozwiązanie problemów, które pojawiły się w takcie prób integracji aplikacji klienckich API,
  • rozwiązanie problemów związanych z importem i eksportem danych przez API.

Wydarzenie ma charakter hackathonu i nie jest szkoleniem z API PBN.

Do udziału w spotkaniu prosimy o wytypowanie osób posiadających wiedzę na temat zasad działania API PBN oraz mających kompetencje w przeprowadzeniu prac związanych z integracją w środowisku PBN Alpha oraz w środowisku produkcyjnym. Prosimy o wcześniejsze przygotowanie problematycznych zagadnień (prośba o posługiwanie się jedynie danymi testowymi). W przypadku potencjalnego wykrycia błędów należy je zgłaszać niezwłocznie do działu Helpdesk (nie czekając na Hackathon).

Rejestracja odbywa się pod następującym adresem: https://zgloszenia.opi.org.pl/zgloszenia-opi-open-api/

Link do platformy zoom oraz informacje o kanałach na platformie Slack, zostaną rozesłane do osób zarejestrowanych na dwa dni przed wydarzeniem.

Zachęcamy Państwa do uczestniczenia w naszym wydarzeniu i aktywności – szczególnie w części konsultacyjnej spotkania.

Poniżej znajdziecie Państwo materiały pomocnicze:

Zapraszamy do zapoznania się z treścią zagadnień poruszanych na Hackathonie – https://pbn.nauka.gov.pl/centrum-pomocy/faq-kategoria/hackathon-api/

 

Wdrożenie wersji 21.8.0.

W dniu 23.08.2021 r.  zaktualizowano system do wersji 21.8.0.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu: 

  • dodanie w zestawieniu publikacji z Profilu Instytucji PBN punktów źródła dla rozdziałów
  • rozszerzenie punktacji dla materiałów konferencyjnych na lata 2017-2018
  • dodanie języka akadyjskiego i sumeryjskiego
  • zmiana położenia i nazwy kafelka Profilu Instytucji na Profil Instytucji PBN

  • korekta punktacji dla czasopisma Historyka. Studia MetodologicznemniswId 483942
  • korekta funkcjonalności zmiany czasopism w szczegółach publikacji

Najważniejsze modyfikacje API :

  • umożliwienie osobom z rolą Menadżera Aplikacji podglądu listy osób generujących tokeny użytkownika w obrębie danej instytucji
  • korekta importu prac z dużą ilością autorów
  • korekta wyświetlania oświadczeń w Profilu Instytucji PBN

Wdrożenie wersji 21.7.6.

W dniu 23.07.2021 r.  zaktualizowano system do wersji 21.7.6.

Najważniejsze modyfikacje/funkcjonalności wprowadzone we wdrożeniu: 

  • rozszerzenie Sugestii dorobku do dodania na Profilu Autora – w Sugestiach pojawiają się publikacje z inną rolą niż autor (redaktor naukowy, autor przekładu, redaktor naukowy przekładu)
  • naprawa błędu zdublowanych wpisów na liście autorów
  • naprawa błędu braku aktualizacji publikacji na Profilu Autora w przypadku usunięcia lub dodania DOI publikacji
  • naprawa błędu masowego dodawania publikacji z ORCID

Najważniejsze modyfikacje API :

  • umożliwienie usunięcia daty oświadczenia  – w celu usunięcia daty oświadczenia należy w węźle „statements” w „statementDate” wpisać null lub pozostawić pusty string („”)
    1. usuwanie poprzez null –

      „statements”:[
      {
      „disciplineId”: „202”,
      „type”: „AUTHOR”,
      „personObjectId”: „5e7092ac878c28a04739a675”,
      „statementDate”: null
      }
      ]

    2. usuwanie z pustym stringiem –

      „statements”:[
      {
      „disciplineId”: „202”,
      „type”: „AUTHOR”,
      „personObjectId”: „5e7092ac878c28a04739a675”,
      „statementDate”: „”
      }
      ]

  • umożliwiono dodawanie numeru DOI dla publikacji bez DOI – w pliku koniecznym jest podanie ObjectId publikacji, dla której chcemy dodać DOI; żądanie będzie realizowane wyłączenie dla ObjectId bez DOI w PBN i przy podaniu DOI niewystępującego już w PBN

Na stronach pomocy PBN zaktualizowano plik z opisem zachodzących walidacji na nadsyłanych publikacjach – https://pbn.nauka.gov.pl/centrum-pomocy/baza-wiedzy/publikacje/

 

Uczelnie zintegrowane z API na wersji produkcyjnej systemu PBN 2.0

Centrum Astronomiczne im. Mikołaja Kopernika Politechnika Rzeszowska im. Ignacego Łukasiewicza Politechnika Wrocławska
 Szkoła Główna Handlowa Uniwersytet w Białymstoku Uniwersytet Jagielloński
Uniwersytet Szczeciński Uniwersytet Wrocławski Warszawski Uniwersytet Medyczny
Zachodniopomorski Uniwersytet Technologiczny w Szczecinie Politechnika Gdańska Uniwersytet Medyczny w Białymstoku
Politechnika Poznańska Uniwersytet Ekonomiczny w Krakowie Uniwersytet Mikołaja Kopernika w Toruniu
Akademia Pedagogiki Specjalnej im. Marii Grzegorzewskiej Uniwersytet Medyczny w Lublinie Uniwersytet Opolski
Politechnika Białostocka Instytut Botaniki im. W. Szafera PAN Akademia Kaliska
Akademia Górniczo-Hutnicza w Krakowie
i inne.

Wdrożenie rozszerzenia API o Wyszukiwarkę (search-controller)

W dniu dzisiejszym na środowisko produkcyjne PBN oraz na środowisko testowe PBN-Alpha wdrożone zostało rozszerzenie API o końcówki umożliwiające wyszukiwanie według kryteriów.

Dostępne jest sześć endpointów pozwalających na wyszukiwanie:

  1. Konferencji
  2. Instytucji
  3. Czasopism
  4. Osób
  5. Publikacji
  6. Wydawnictw

Opis poszczególnych końcówek zostanie udostępniony na stronach pomocy systemu PBN.