2. Ako používať API 

• The communication dialogue between remote (third party) applications and LabCollector is based on HTTP 1.1 protocol. (*Ak chcete skontrolovať, čo je zdroj, pozrite si obrázok vyššie)

  

• Prostriedok môžete upravovať, čítať, vytvárať alebo mazať pomocou GET, POST, PUT a DELETE metóda ako je znázornené na obrázku vyššie.
• Môžete požiadať o úpravu a potom dostanete odpoveď na úpravu, ako je vysvetlené nižšie.
• Napríklad účel sme použili Aplikácia POŠTÁR Nástroj pre API a rozhranie vyzerá nižšie.
  

• As you can see in the above image you can type the API URL (for example link to LabCollector’s Strains & Cells module) and after you finish the modifications and hit send you will get a response.
  Ak je všetko v poriadku a požiadavka bola vykonaná, odpoveď bude vyzerať nižšie v aplikácii Postman.
  
• 1. Tu si môžete vybrať spôsob vašej požiadavky. (GET, POST, PUT a DELETE)
• 2. Požiadavka na API vyžaduje určité špecifické HTTP/HTTPS hlavičky.
• 3. Súhlasím hlavička definuje požadovaný formát odpovede vašej požiadavky, text/XML (predvolené) alebo aplikáciu/JSON.
• 4. X-LC-APP-Auth hlavička, do ktorej vložíte svoj aplikačný token, ktorý je potrebný na autorizáciu vašej požiadavky na API.
• 5. X-LC-APP-charset header defines the character encoding of your application. It allows the API to send back the response with the appropriate encoding and to correctly convert your POST and PUT requests to the LabCollector’s character encoding (ISO 8859-1).

3. API for LabCollector: Uniform Resource Identifier (URI)

• Uniform Resource Identifier (URI) je reťazec znakov, ktorý jednoznačne identifikuje konkrétny zdroj.

• Prepis adresy URL ZAPNUTÝ (mod_rewrite)
  Poznámka: Musíte to urobiť vo svojom súbore Apache.
  

  [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]

• Normálne adresy URL:

  [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD] 

• To know more about the URI and how to use it with LabCollector, Prosím read our manual on LabCollector API strana 7-17.

4. Príklady API

• Príklad kódov v C#

  string url = _Url.Replace("{id}", txtDataID.Text); var klient = new RestSharp.RestClient(url); klient.Časový limit = 900000; var request = new RestSharp.RestRequest(); request.Timeout = 900000; request.Metoda = Method.GET; request.AddHeader("X-LC-APP-Auth", token); request.AddHeader("Prijať", "text/xml"); //////////////////// IRestResponse response = client.Execute(request); reťazec výsledok = odpoveď.Obsah;

• Príklad kódov v PHP:

  NA PRÍJEM INFORMÁCIÍ HLAVIČKY Z API $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>

• Príklad API na poslať súbor:

  <?php
  set_time_limit(0);
  $url = "http://xxxxxxxxxxx/webservice/index.php?v=2&module=plasmids&data_id=3";
  $file_path = 'zz_labcollector.rar';
  $file_info = getimagesize($file_path);
  $file_size = filesize($file_path);
  $update = array(
  'health_report_file[0]' => '@'.$file_path.";filename=zz_labcollector.rar;type=application/x-rar-compressed",
  'health_report_file[1]' => '@'.$file_path2.";filename=zz_labcollector2.rar;type=application/x-rar-compressed",
  'upload_mode' => 'add'
  );
  $curl = curl_init();
  curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-LC-APP-Auth: TOKEN', 'Content-Type: '.$file_info['mime'])); 
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
  curl_setopt($curl, CURLOPT_POSTFIELDS, $update);
  curl_setopt($curl, CURLOPT_CONNECTTIMEOUT ,0);
  curl_setopt($curl, CURLOPT_TIMEOUT, 0);
  curl_setopt($curl, CURLOPT_HEADER, true); //OPTIONAL -> TO RECEIVE HEADER INFO FROM THE API
  $API_response = curl_exec($curl);
  curl_close($curl);
  echo($API_response);

5. LSM API

• Lab Service Manager (LSM) je náš doplnok pre základné služby/testovacie laboratóriá.
• Ako bolo vysvetlené vyššie, môžete nakonfigurovať pripojenie k doplnku LSM (začiarknutím políčka pred doplnkami), ako je znázornené na časť 1 vyššie.
• Pomocou API môžete použiť metódu GET na čítanie/získavanie informácií o rôznych parametroch, ktoré používate v teste, ako je názov vzorky, stav testu, informácie o šarži, ID úlohy atď.
• Prosím naše KB na LSM API.
• To know more about the LSM API and how to use it with LabCollector, Prosím prečítajte si našu príručku k API strana 18-28.

6. ELN API

• Elektronický laboratórny notebook (ELN) add-on is the replacement of a paper lab notebook. 
• As explained before you can configure to connect to the ELN add-on (by checking the box in front of add-ons as shown in časť 1 vyššie.
• Pomocou API môžete použiť metódu GET a POST na čítanie/získavanie informácií o údajoch kníh, experimentov a stránok.
• Prosím naše KB zapnuté ELN API.
• Ak sa chcete dozvedieť viac o ELN API and how to use it with LabCollector, Prosím read our manual on ELN API strana 29-30.

7. Workflow API *NOVÝ

• Doplnok Workflow môžu využívať inštitúcie, ktoré chcú dodržiavať prísny protokol overovania krok za krokom.
• LabCollector now offers to connect to workflow add-on with the help of API.
• Pomocou rozhrania API pracovného toku teraz môžete vykonať danú úlohu alebo dokončiť uzol. (uzol je proces alebo krok v doplnku pracovného postupu)
• To know more about the workflow API and how to use it with LabCollector, Prosím prečítajte si našu príručku k Workflow API.

8. Riešenie problémov (chybové hlásenia)

• Pri vykonávaní funkcií API sa môžu vyskytnúť chyby.
• Tieto chyby môžete odstrániť pomocou nášho KB na chybové hlásenia API.
• To know more about the LSM API and how to use it with LabCollector, Prosím prečítajte si náš manuál o LSM API.

9. API služby Annex-Web

• Príloha popisuje čisté adresy URL, ktoré sa majú používať, aby správne fungovali.
• Príloha popisuje všetky URI, ktoré sa majú použiť s príslušným modulom a popisom a tiež vás informuje o metóde (PUT, POST, atď.), ktorá sa má na to použiť.
• Musíte povoliť nástroju apache, aby používal URI popísané v prílohe. Čítajte alebo KB ďalej nastavenie webovej služby/apache.
• To know more about the LSM API and how to use it with LabCollector, Prosím prečítajte si našu príručku k API strana 33-37.

Súvisiace témy:

• Prečítajte si naše manuál na LabCollector.
• Prečítajte si naše manuál k API.
• Pozrite si naše KB na LSM API.
• Pozrite si naše KB zapnuté ELN API.
• Prečítajte si naše KB na Workflow API.
• Prečítajte si našu KB ďalej nastavenie webovej služby/apache.
• Prečítajte si našu KB ďalej Chybové hlásenia API.
• Kontrola ako vytvoriť úložné boxy/platne s API.