Johdatus LabCollector Sovellusliittymä - LabCollector

Hae tietokannasta avainsanan mukaan

Sinä olet täällä:
← Kaikki aiheet
YHTEENVETO:

API on sovellusohjelmointirajapinta, joka määrittää useiden ohjelmistovälittäjien väliset vuorovaikutukset. Yksinkertaisesti sanottuna sen avulla kaksi sovellusta voivat puhua toisilleen. Esimerkiksi kun käytät mitä tahansa sovellusta matkapuhelimellasi nähdäksesi Facebookin, Instagramin tai sääsovelluksen, käytät API:ta. Samoin, jos käytät LabCollector LIMS ja haluat muodostaa yhteyden kolmannen osapuolen ohjelmistoon, voit muodostaa yhteyden API:n kautta.

- LabCollector Web Service Application Programming Interface (API) sallii kolmannen osapuolen sovellusten olla vuorovaikutuksessa molempien kanssa LabCollector's tietokanta (moduulit) ja LabCollector lisäosat (ELN ja LSM).

AgileBio tarjoaa API:lle (ne selitetään alla olevissa osioissa): -

  • Main LC API: Tämän avulla voit työstää/purkaa moduulitietoja (näytteitä...), tallentaa, hakea/asettaa tiedostoja…
  • ELN API: Tämä auttaa sinua työskentelemään kirjojen/sivujen parissa (hae/lisää), lataamaan tiedostoja/kuvia
  • LSM API: Tämän avulla voit työskennellä analyyttisten / palveluiden parissa (lisää työpaikkoja, päivitä tuloksia, hanki tuloksia…)
  • WF API (Uusi!): Tämä voi auttaa käynnistämään uusia työnkulkuja ja muuttaa tilaa

API perustuu REST (Representational State Transfer) -arkkitehtuuriin, joka mahdollistaa pääsyn resurssit Uniform Resource Identifierin (URI) ja niihin liittyvien toimien kautta. 

API tarjoaa myös tietoturvan tietojen eheyden suhteen. Esimerkiksi kun kaksi sovellusta keskustelevat API:n kanssa, ne puhuvat vain pienistä tietopaketteista, mikä on välttämätöntä. Esimerkiksi kun tilaat tuotteen Amazonista. Välität vain haluamasi kohteet ja sitten ne toimitetaan sinulle. Et törmää koko tuotteen valmistus- tai pakkaus- tai kuljetusprosessiin jne. Samat tiedot sisään LabCollector näkyy vain joissakin osissa (resursseissa), joita voidaan muokata API:n avulla.

Noudata näitä ohjeita määrittääksesi LabCollector API: -

1. API yleiset asetukset

2. API:n käyttö 

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

4. Esimerkkejä API:sta

5. LSM API

6. ELN API

7. Työnkulun API *UUSI

8. Vianetsintä (virheilmoitukset)

9. Liite-Web-palvelun API

1. API yleiset asetukset

  • API:n määrittäminen sisään LabCollector sinun on ilmoitettava hakemuksesi LabCollector.
  • Voit tehdä sen kirjautumalla sisään LabCollector kuten superadmin. 
    * Lue KB nähdäksesi mitkä ovat superadmin-oikeudet LabCollector.
  • In LabCollector kun kirjaudut sisään mene osoitteeseen ADMIN -> SETUP -> VERKKOPALVELUJEN API

  • Näet alla olevan sivun, jolla voit määrittää uuden sovelluksen, johon haluat muodostaa yhteyden LabCollector API:n kautta.

 

  • 1. NIMI: Täällä voit lisätä sovelluksesi nimen. Olemme esimerkiksi lisänneet lisäosan nimen, joka vastaanottaa näytteitä.
  • 2. OLETUSOPERAATTORI: Täällä voit kirjoittaa henkilön, jonka haluat olla tämän API:n operaattori. Jos et lisää operaattoria tähän, sinun on lisättävä se jokaisen API:n kautta tekemäsi pyynnön yhteydessä.
  • 3. IP-RAJOITUS: Tämä vaihtoehto mahdollistaa suojaustason, koska voit määrittää tässä, mitkä IP-osoitteet (Internet Protocol) saavat toimia määrittämässäsi API:ssa. Muista, että jos valitset "kyllä", IP-osoitteen syöttöruutu tulee näkyviin vasta, kun olet tallentanut asetuksesi.
  • 4. TÄHÄN SOVELLUKSEN LIITTEET MODULIT: Siinä on oletusarvoisesti 12 moduulia LabCollector. Tämän lisäksi voit myös luoda uusia mukautettuja lisäosia tarpeidesi mukaan. Kaikki oletusasetukset ja mukautetut moduulit ja lisäosat ovat täällä, ja voit valita, mitkä moduulit haluat olla vuorovaikutuksessa API:n kanssa.
  • 5. LISÄTÄ: Kun olet määrittänyt asetukset, voit napsauttaa Lisää ja API näyttää alla.
  • A. Nyt voit lisätä IP-osoitteen ja napsauttaa "Lisää uusi IP".
  • B. Napsauttamalla päivityskuvaketta voit muokata API-asetuksiasi.
  • C. Tämä on tunnusnumerosi, jota voidaan käyttää API-yhteyden muodostamiseen. Voit jopa luoda sille viivakoodin ja kopioida sen napsauttamalla kuvaketta.
 HUOMAUTUS: Huomautus: Jotta voit käyttää tätä ominaisuutta, sinun on aktivoitava Curl PHP-asetuksissasi. Linuxissa asenna PHP-Curl-paketti. Muokkaa Windowsissa ja automaattisella asennusohjelmallamme Curlin PHP.ini-laajennuksia ja poista kommentteja (extension=php_curl.dll).

2. API:n käyttö 

  • Viestintävuoropuhelu etäsovellusten (kolmannen osapuolen) välillä LabCollector perustuu HTTP 1.1 -protokollaan. (*Jos haluat tarkistaa, mikä on resurssi, katso yllä oleva kuva)

  • Voit muokata, lukea, luoda tai poistaa resurssia GET-, POST-, PUT- ja DELETE-painikkeilla. menetelmä kuten yllä olevassa kuvassa näkyy.
  • Voit pyytää muutosta ja saada sitten vastauksen muutokseen alla kuvatulla tavalla.
  • Esimerkiksi tarkoitukseen käytimme POSTIMAN sovellus Työkalu API:lle ja käyttöliittymä näyttää alla.

  • Kuten yllä olevasta kuvasta näet, voit kirjoittaa API URL-osoitteen (esimerkiksi linkin osoitteeseen LabCollector's Strains & Cells -moduuli) ja kun olet tehnyt muutokset ja painat Lähetä, saat vastauksen.
    Jos kaikki on oikein ja pyyntö on suoritettu, vastaus näyttää alla olevalta Postimies-sovelluksessa.
  • 1. Täältä voit valita pyyntösi menetelmän. (HANKI, LÄHETÄ, LAITA ja POISTA)
  • 2. API-pyyntö vaatii tietyn HTTP/HTTPS:n otsikot.
  • 3. - Hyväksyä otsikko määrittää pyyntösi halutun vastausmuodon, tekstin/XML:n (oletus) tai sovelluksen/JSONin.
  • 4. - X-LC-APP-Auth otsikko, johon asetat sovellustunnuksesi, joka on tarpeen pyyntösi valtuuttamiseksi API:lle.
  • 5. - X-LC-APP-merkki otsikko määrittää sovelluksesi merkkikoodauksen. Sen avulla API voi lähettää vastauksen takaisin asianmukaisella koodauksella ja muuntaa POST- ja PUT-pyyntösi oikein LabCollectormerkin koodaus (ISO 8859-1).

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

  • Uniform Resource Identifier (URI) on merkkijono, joka yksilöi yksiselitteisesti tietyn resurssin.

  • URL-osoitteen uudelleenkirjoitus PÄÄLLÄ (mod_rewrite)
    Huomautus: Sinun on tehtävä tämä apache-tiedostossasi.

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]

  • Normaalit URL-osoitteet:

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULI]?name=[AVAINSANA]
  • Lisätietoja URI:sta ja sen käytöstä LabCollector, Ota lue käyttöohjeemme LabCollector API sivu 7-17.

4. Esimerkkejä API:sta

  • Esimerkki koodeista C# 
    string url = _Url.Replace("{id}", txtDataID.Text); var client = new RestSharp.RestClient(url); client.Timeout = 900000; var request = new RestSharp.RestRequest(); request.Timeout = 900000; request.Method = Method.GET; request.AddHeader("X-LC-APP-Auth", tunnus); request.AddHeader("Hyväksy", "teksti/xml"); //////////////////// IRestResponse response = client.Execute(request); merkkijono tulos = vastaus.Content;
  • Esimerkki koodeista PHP: 
    OTSIKKOTIEDON SAATTAMISEKSI API:STA $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>
  • Esimerkki API että lähetä tiedosto: 
    labcollector.rar'; $tiedosto_info = getimagesize($tiedoston_polku); $tiedoston_koko = tiedostokoko($tiedoston_polku); $update = array( 'health_report_file[0]' => '@'.$file_path.";tiedostonimi=zz_labcollector.rar;type=application/x-rar-compressed", 'health_report_file[1]' => '@'.$tiedoston_polku2.";tiedostonimi=zz_labcollector2.rar;tyyppi=sovellus/x-rar-pakattu", 'upload_mode' => 'lisää' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-LC-APP-Auth: TOKEN', 'Content-Type: '.$file_info['mime'])); ; curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT"); _HEADER , tosi);

5. LSM API

  • Lab Service Manager (LSM) on palvelun ydin-/testilaboratorioiden lisäosamme.
  • Kuten edellä on selitetty, voit määrittää yhteyden muodostamaan LSM-lisäosaan (valitsemalla lisäosien edessä olevan ruudun) kuvan osoittamalla tavalla. jakso 1 edellä.
  • Voit käyttää API:ta GET-menetelmän avulla lukeaksesi/hakeaksesi tietoja erilaisista testissä käyttämistäsi parametreista, kuten näytteen nimi, määrityksen tila, erätiedot, työtunnus jne.
  • Ole hyvä ja meidän KB LSM API:ssa.
  • Lisätietoja LSM API:sta ja sen käytöstä LabCollector, Ota lue API-oppaamme sivu 18-28.

6. ELN API

  • Elektroninen Lab-muistikirja (ELN) -lisäosa on paperisen laboratoriomuistikirjan korvaaminen. 
  • Kuten edellä selitettiin, voit määrittää yhteyden muodostamiseen ELN lisäosa (valitsemalla lisäosien edessä oleva ruutu kuvan mukaisesti jakso 1 edellä.
  • API:n avulla voit käyttää GET- ja POST-menetelmiä kirjojen, kokeiden ja sivujen tietojen lukemiseen/hakuun.
  • Ole hyvä ja meidän KB päällä ELN API.
  • Jos haluat tietää enemmän ELN API ja kuinka sitä käytetään LabCollector, Ota lue käyttöohjeemme ELN API sivu 29-30.

7. Työnkulun API *UUSI

  • Työnkulun lisäosaa voivat käyttää laitokset, jotka haluavat noudattaa tiukkaa vaiheittaista validointiprotokollaa.
  • LabCollector tarjoaa nyt yhteyden työnkulun lisäosaan API:n avulla.
  • Työnkulun API:n avulla voit nyt suorittaa tietyn työn tai täydentää solmun. (solmu on prosessi tai vaihe työnkulun lisäosassa)
  • Saat lisätietoja työnkulun API:sta ja sen käyttämisestä LabCollector, Ota lue Workflow API -oppaamme.

8. Vianetsintä (virheilmoitukset)

9. Liite-Web-palvelun API

  • Liitteessä kuvataan puhtaat URL-osoitteet, joita käytetään toimimaan oikein.
  • Liitteessä kuvataan kaikki URI:t, joita käytetään vastaavan moduulin ja kuvauksen kanssa, ja kerrotaan myös käytettävä menetelmä (PUT, POST jne.).
  • Sinun on sallittava apache-moottori käyttää liitteessä kuvattua URI:tä. Lue tai KB päällä verkkopalvelu/apache-asetukset.
  • Lisätietoja LSM API:sta ja sen käytöstä LabCollector, Ota lue API-oppaamme sivu 33-37.

Aiheeseen liittyviä aiheita: