Interfejs programistyczny aplikacji: Różnice pomiędzy wersjami

Z Otwarty System Antyplagiatowy
Skocz do: nawigacja, szukaj
(Utworzono nową stronę " Otwarty system antyplagiatowy udostępnia dwa interfejsy komunikacji, jeden do wersji lokalnej instalowanej na komputerze uczelni, drugi do Nekst umo...")
 
(API Nekst)
Linia 12: Linia 12:
 
= API Nekst =
 
= API Nekst =
  
Serwis REST API znajduje się pod adresem: [https://api.antyplagiat.nekst.pl/].
+
Serwis REST API znajduje się pod adresem: [https://api.antyplagiat.nekst.pl/ 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.
 
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.

Wersja z 17:40, 30 cze 2015

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).


API OSA

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