Interfejs programistyczny aplikacji
Otwarty system antyplagiatowy udostępnia dwa interfejsy komunikacji, jeden do wersji lokalnej instalowanej na komputerze uczelni, drugi do Nekst umożliwiający sprawdzanie prac w internecie (korzysta z niego wersja lokalna).
Obydwa interfejsy zostały wykonane w oparciu o REST (Representational State Transfer).
Spis treści
API OSA
Aktualna wersja została opracowana na potrzeby integracji z systemem USOS. Docelowo chcemy ją rozszerzyć by można było się zintegrować z dowolnym oprogramowaniem.
Tworzenie zadań i odbieranie raportów
POST: http://<adres serwera osa>/api/job/create
parametry:
- reportURL - Adres do przesłania raportu (adres zwrotny)
- university - Nazwa uniwersytetu
- polonCode - Kod POL-on uniwersytetu
- languageCode - Kod ISO języka pracy
- documentType - Typ pracy
- faculty - Jednostka podstawowa
- fieldOfStudy - Kierunek studiów
- knowledgeArea - Obszar wiedzy
- title - Tytuł pracy
- author - Autor
- promoter - Promotor
- reviewer - Recenzent
- file - Plik
odpowiedź:
- status - Status zgłoszenia
- message - Tekstowy komunikat
- guid - Identyfikator zgłoszenia
Po wykonanej analizie antyplagiatowej system próbuje odesłać raport na wskazany adres (reportURL) przekazując następujące parametry:
- id - Identyfikator zgłoszenia (GUID)
- file - Plik z raportem
oczekując następujących parametrów:
- status - Status
- message - Komunikat
Mapowanie kodów obszarów:
- [OB01] Obszar nauk humanistycznych
- [OB02] Obszar nauk społecznych
- [OB03] Obszar nauk ścisłych
- [OB04] Obszar nauk przyrodniczych
- [OB05] Obszar nauk technicznych
- [OB06] Obszar nauk rolniczych, leśnych i weterynaryjnych
- [OB07] Obszar nauk medycznych i nauk o zdrowiu oraz nauk o kulturze fizycznej
- [OB08] Obszar sztuki
API Nekst
Serwis REST API znajduje się pod adresem: api.antyplagiat.nekst.pl.
Komunikacja odbywa się za pomocą protokołu HTTP (GET i POST), zaś odpowiedzi zwrotne są mapowane na JSON’a lub XML’a w zależności od parametru nagłówka (HTTP header) Accept: application/json lub Accept: application/xhtml+xml.
Autoryzacja
W celu uzyskania dostępu do API należy pobrać token autoryzacyjny za pomocą poniższej metody:
GET: antyplagiat.nekst.pl/auth/getToken?login={login}
parametry:
- login - nazwa użytkownika dostarczona przez administratora.
Każdorazowe wykonanie jakiejkolwiek metody z API wymaga wcześniejszego pobrania nowego tokenu oraz parametru md5 obliczonego według wzoru:
$md5 = md5 ( md5 ( $apiKey ) + $tokenFromGetTokenMethod );
gdzie:
- md5() - funkcja skrótu MD5
- $md5 - parametr przekazywany przy dostępie do API
- $tokenFromGetTokenMethod - token uzyskany za pomocą metody “getToken”
- $apiKey - klucz dostępowy do API uzyskany od administratora
Jeśli chcemy sprawdzić naszą metodę wyliczenia parametru $md5 możemy skorzystać z metody:
GET: antyplagiat.nekst.pl/auth/checkToken?login={login}&md5={md5}
parametry:
- token - token autoryzacyjny
- md5 - skrót klucza dostępowego i tokenu
Stworzenie zadania
Stworzenia nowego zadania dla danego tekstu odbywa się za pomocą metody:
POST: api.antyplagiat.nekst.pl/task/create
parametry:
- token - token autoryzacyjny
- md5 - skrót klucza dostępowego i tokenu
- query - tekst do sprawdzenia (plain/text)
- filename - nazwa pliku
Sprawdzenie statusu zadania
W celu sprawdzenia w jakim stanie znajduje się nasze zadanie należy skorzystać z metody:
GET: antyplagiat.nekst.pl/task/check
parametry:
- token - token autoryzacyjny
- md5 - skrót klucza dostępowego i tokenu
- taskId - identyfikator naszego zadania otrzymany za pomocą metody tworzenia nowego zadania
Pobieranie wyników zadania
Gdy nasze zadanie ma status: DONE można pobrać wyniki korzystając z metody:
GET: antyplagiat.nekst.pl/task/result
parametry:
- token - token autoryzacyjny
- md5 - skrót klucza dostępowego i tokenu
- taskId - identyfikator naszego zadania otrzymany za pomocą metody tworzenia nowego zadania
Dalsze prace
Aktualnie pracujemy nad integracją z ORPPD oraz innymi bazami i systemami (DSpace, Moodle, etc), dlatego API uczelniane zostanie przebudowane, zaś API Nekst zostanie zastąpione uogólnionym API obsługującym zarówno ORPPD, NEKST oraz inne bazy danych.