API

V súčasnosti sú k dispozícii cez API tri funkcie a autentifikácia:

vyhľadávanie v databáze pojmov api/search
informácie o pojme api/concept
extrakcia pojmov z textu api/extractor

Pre používanie API volaní je potrebný autentifikačný token, ktorý získate na: api/auth

Autentifikácia: POST /api/auth

Na autentifikáciu sa používa štandardný autentifikačný token JWT (JSON Web Token), ktorý platí 24 hodín.

Vstupné parametre

email: email používateľa
password: heslo používateľa

Výstupné hodnoty

message: stav
token: autorizačný token

Ukážka kódu pre Python:

endpoint = "https://pojmy.kinit.sk/api/auth"
logindata = {"email": "moj@email.loc", "password": "superTajneHeslo"}
response = requests.post(endpoint, data=logindata)

Ukážka kódu pre PHP:

$logindata = ["email" => "moj@email.loc", "password" => "superTajneHeslo"];
$ch        = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://pojmy.kinit.sk/api/auth");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($logindata));
$response  = curl_exec($ch);

Následne treba vygenerovaný token pridať do hlavičky každej požiadavky v tvare: authorization: Bearer <TOKEN> kde <TOKEN> je váš token (za slovom Bearer nasleduje medzera a potom token).

Vyhľadanie pojmov: GET /api/search

Vstupné parametre

lemma: základný tvar slova (napr. beh)
namespace: kategória slova - nepovinné (napr.: Aktivity/Športy)

Výstupné hodnoty

results: výsledky (zoznam vzťahov)

Ukážka kódu pre Python:

endpoint = "https://pojmy.kinit.sk/api/search"
headers = {"Authorization": "Bearer MOJ-TOKEN"}
params = {"lemma": "beh"}
response = requests.get(endpoint, params=params, headers=headers)

Ukážka kódu pre PHP:

$params  = ["lemma" => "beh"];
$headers = ["Content-Type: application/json", "Authorization: Bearer MOJ-TOKEN"];
$ch      = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://pojmy.kinit.sk/api/search?".http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response  = curl_exec($ch);

Získanie informácii o pojme: GET /api/concept

Vstupné parametre

lemma: základný tvar slova (napr. beh)
namespace: kategória slova - nepovinné (napr.: Aktivity/Športy)

Výstupné hodnoty

results: výsledky (zoznam vzťahov)

Ukážka kódu pre Python:

endpoint = "https://pojmy.kinit.sk/api/concept"
headers = {"Authorization": "Bearer MOJ-TOKEN"}
params = {"lemma": "beh"}
response = requests.get(endpoint, params=params, headers=headers)

Ukážka kódu pre PHP:

$params  = ["lemma" => "beh"];
$headers = ["Content-Type: application/json", "Authorization: Bearer MOJ-TOKEN"];
$ch      = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://pojmy.kinit.sk/api/concept?".http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response  = curl_exec($ch);

Získanie informácii o pojme: GET /api/extractor

Vstupné parametre

text: veta na extrakciu pojmov

Výstupné hodnoty

results: výsledky (zoznam vzťahov)

Ukážka kódu pre Python:

endpoint = "https://pojmy.kinit.sk/api/extractor"
headers = {"Authorization": "Bearer MOJ-TOKEN"}
params = {"text": "Bežec beží po nábreží."}
response = requests.get(endpoint, params=params, headers=headers)

Ukážka kódu pre PHP:

$params  = ["text" => "Bežec beží po nábreží."];
$headers = ["Content-Type: application/json", "Authorization: Bearer MOJ-TOKEN"];
$ch      = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://pojmy.kinit.sk/api/extractor?".http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response  = curl_exec($ch);