Application Programming Interface
Welcome to the generated BioKnExt API
English:
This procedure describes the API of the Biological Knowledge Extractor (BioKnExt). The system was developed using the Laravel framework.
Its interoperability with external infrastructures is made possible via a REST API system. The database is developed in PostgreSQL.
Français :
Cette procédure décrit l'API de l'extracteur de connaissances biologiques (BioKnExt). Le système a été développé en utilisant le framework
Laravel. Son interopérabilité avec des infrastructures externes est rendue possible via un système d'API REST. La base de données est développée en PostgreSQL.
HTTP Request
POST api/EntityExtraction
Body parameters
English:
When the verification is successfull, the data is returned in the "data" part. This section contains 3 columns ("startInText", "endInText" and "mutation") separated by tabulations ("/t"). Each entity is on a new line and lines are separated by a line break ("/n").
When the verification failed, the data is empty. Error type is contained in "errors" section.
Français :
Lorsque la vérification est réussie, les données sont retournées dans la partie "data". Cette partie contient 3 colonnes ("startInText", "endInText" et "mutation") séparées par des tabulations ("/t"). Chaque entité est sur une nouvelle ligne et les lignes sont séparées par un saut de ligne ("/n").
Lorsque la vérification a échoué, les données sont vides. Le type d'erreur est contenu dans la section "erreurs".
Example request (bash):
curl --location --request POST 'http://bioknext.eu/api/EntityExtraction' \
--form 'file=@"wu_2021.pdf"'
Example request (PHP):
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://bioknext.eu/api/EntityExtraction',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('file'=> new CURLFILE('wu_2021.pdf')),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Example request (Python):
import requests
url = "http://bioknext.eu/api/EntityExtraction"
payload={}
files=[
('file',('wu_2021.pdf',open('wu_2021.pdf','rb'),'application/pdf'))
]
headers = {}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Example response (200):
Example response (422):
