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

Wersja testowa API PBN – informacje ogólne

Wersja testowa API PBN jest dostępna pod adresem: https://pbn-micro-alpha.opi.org.pl/api/

Wykaz wraz ze specyfikacją dostępnych końcówek obejmuje następujące funkcjonalności:

  • dodawanie/edycja publikacji,
  • import wielu publikacji celem dodania i edycji,
  • pobieranie metadanych publikacji, konferencji, czasopism, instytucji, osób w publikacjach.

Dane w systemie PBN są prezentowane w celu zgodnym z zapisem art. 343 ust. 6 Ustawy z dnia 20 lipca 2018 r. Prawo o szkolnictwie wyższym i nauce. Zabronione jest wykorzystywanie danych zawartych w systemie PBN w innych celach niż określone w ustawie.

Nowe API

REST JSON API – Nowe API PBN jest oparte wyłącznie na danych w formacie JSON oraz komunikacji System-to-System.

Uproszczone obiekty – W nowym API serwujemy uproszczone obiekty zawierające tylko istotne informacje

Brak importu XML – Tradycyjny  import XML nie będzie obsługiwany z racji zmiany podejścia do sposobu przetrzymywania metadanych.

Grupy endpointów:

  • /conferences/ – dostęp do konferencji
  • /dictionary/ – dostęp do krajów, dyscyplin, języków
  • /institution/ – dostęp do instytucji
  • /journals/ – dostęp do czasopism
  • /person/ – dostęp do osób (pracowników i autorów)
  • /publications/ – dostęp do publikacji
  • /publisher/ – dostęp do wydawców

Uwierzytelnianie i autoryzacja

Z API mogą korzystać użytkownicy, którzy w swoich zapytaniach będą przesyłać następujące nagłówki:

  • X-App-Id – identyfikator aplikacji dla instytucji zarejestrowanej w API
  • X-App-Token – token wystawiony dla ww. aplikacji. Token musi być ważny.
  • X-User-Token – token wystawiony dla użytkownika w ramach ww. aplikacji. Token musi być ważny.

W wypadku końcówek, które pobierają metadane wystarczy podać dwa nagłówki: X-App-Id oraz X-App-Token.