Predstavitev LabCollector API - LabCollector

Iskanje po zbirki znanja po ključnih besedah

Tukaj ste:
← Vse teme
POVZETEK:

API je aplikacijski programski vmesnik, računalniški vmesnik, ki definira interakcije med več programskimi posredniki. Z enostavnimi besedami omogoča, da se dve aplikaciji pogovarjata. Na primer, ko uporabljate katero koli aplikacijo na svojem mobilnem telefonu za ogled Facebooka, Instagrama ali vremenske aplikacije, uporabljate API. Podobno, če uporabljate LabCollector LIMS in se želite povezati s programsko opremo tretjih oseb, se lahko povežete prek API-ja.

O LabCollector Vmesnik za programiranje aplikacij spletnih storitev (API) omogoča aplikacijam tretjih oseb interakcijo z obema LabCollectorbaza podatkov (moduli) in LabCollector dodatki (ELN in LSM).

AgileBio ponuja API za (razloženi so v spodnjih razdelkih):-

  • Glavni LC API: S tem lahko delate/izvlečete podatke modulov (vzorci..), shranjevanje, pridobite/date datoteke ...
  • ELN API: To vam pomaga pri delu s knjigami/strani (pridobivanje/dodajanje), nalaganje datotek/slik
  • LSM API: S tem lahko delate na analitiki / storitvah (dodajate delovna mesta, posodabljate rezultate, pridobivate rezultate ...)
  • WF API (Novo!): To lahko pomaga sprožiti nove poteke dela, spremeniti stanje

API temelji na arhitekturi REST (Representational State Transfer), ki omogoča dostop do sredstva prek Uniform Resource Identifier (URI) in dejanj na njih. 

API zagotavlja tudi varnost v smislu celovitosti podatkov. Na primer, ko se dve aplikaciji pogovarjata z API-jem, se pogovarjata samo v smislu majhnih paketov podatkov, ki so potrebni. Na primer, ko naročite izdelek pri Amazonu. Predmete, ki jih želite, le prenesete in nato vam jih dostavijo. Ne naletite na celoten proces izdelave artikla ali pakiranja ali prevoza itd. Isti podatki v LabCollector je viden samo v nekaterih delih (virih), ki jih je mogoče spreminjati s pomočjo API-ja.

Sledite tem korakom, da konfigurirate LabCollector API:-

1. Splošna nastavitev API-ja

2. Kako uporabljati API 

3. API za LabCollector: Enotni identifikator vira (URI)

4. Primeri API-jev

5. API LSM

6. ELN API

7. API poteka dela *NOVO

8. Odpravljanje težav (sporočila o napakah)

9. Annex-Web service API

1. Splošna nastavitev API-ja

  • Če želite konfigurirati API v LabCollector prijavo morate prijaviti v LabCollector.
  • Če želite to narediti, se prijavite v LabCollector kot superadmin. 
    * Za ogled preberite našo KB v čem so superadmin dovoljenja LabCollector.
  • v LabCollector ko se prijavite, pojdite na ADMIN -> NASTAVITI -> API SPLETNIH STORITEV

  • Videli boste spodnjo stran, kjer lahko določite novo aplikacijo, s katero se želite povezati LabCollector prek API-ja.

 

  • 1. NAME: Tukaj lahko dodate ime svoje aplikacije. Na primer, dodali smo ime našega dodatka, ki je prejemanje vzorcev.
  • 2. PRIVZETI OPERATER: Tukaj lahko vnesete osebo, za katero želite, da je operater za ta API. Če operaterja ne dodate tukaj, ga boste morali dodati med vsako zahtevo, ki jo boste podali prek API-ja.
  • 3. OMEJITEV IP: Ta možnost vam omogoča raven varnosti, saj lahko tukaj določite, kateri naslovi IP (internetni protokol) lahko delujejo na API-ju, ki ga definirate. Ne pozabite, da če izberete »da«, se polje za vnos naslova IP prikaže šele, ko shranite svojo nastavitev.
  • 4. MODULI, POVEZANI S TO APLIKACIJO: Privzeto je prisotnih 12 modulov LabCollector. Poleg tega lahko ustvarite tudi nove dodatke po meri glede na vaše zahteve. Tukaj bodo prisotni vsi privzeti moduli in moduli po meri ter dodatki in lahko izberete, katere module želite uporabljati z API-jem.
  • 5. DODAJ: ko določite svoje nastavitve, lahko kliknete na dodaj in vaš API bo videti kot spodaj.
  • A. Zdaj lahko dodate naslov IP in kliknete »Dodaj nov IP«.
  • B. S klikom na ikono za posodobitev lahko uredite svoje nastavitve API-ja.
  • C. To je vaša številka žetona, ki jo lahko uporabite za povezavo z API-jem. Zanj lahko celo ustvarite črtno kodo in jo kopirate s klikom na ikona.
 OPOMBE: Opomba: Če želite uporabljati to funkcijo, morate aktivirati Curl v nastavitvah PHP. V Linuxu namestite paket PHP-Curl. V sistemu Windows in z našim samodejnim namestitvenim programom uredite PHP.ini in odkomentirajte razširitve za Curl (extension=php_curl.dll).

2. Kako uporabljati API 

  • Komunikacijski dialog med oddaljenimi aplikacijami (tretjih oseb) in LabCollector temelji na protokolu HTTP 1.1. (*Če želite preveriti, kaj je vir, glejte zgornjo sliko)

  • Vir lahko spremenite, preberete, ustvarite ali izbrišete z GET, POST, PUT in DELETE Metoda kot je prikazano na zgornji sliki.
  • Zahtevate lahko spremembo in nato prejmete odgovor za spremembo, kot je razloženo spodaj.
  • Za namen smo uporabili Aplikacija POŠTAR Orodje za API in vmesnik izgleda spodaj.

  • Kot lahko vidite na zgornji sliki, lahko vnesete URL API-ja (na primer povezavo do LabCollectorModul 's Strains & Cells) in ko končate s spremembami in pritisnete Pošlji, boste prejeli odgovor.
    Če je vse pravilno in je bila zahteva izvedena, bo odgovor izgledal kot spodaj v aplikaciji Poštar.
  • 1. Tukaj lahko izberete način vaše zahteve. (GET, POST, PUT in DELETE)
  • 2. Zahteva za API zahteva določen HTTP/HTTPS glave.
  • 3. O Sprejmi glava določa želeno obliko odgovora vaše zahteve, besedilo/XML (privzeto) ali aplikacija/JSON.
  • 4. O X-LC-APP-Auth glavo, kamor vstavite svoj žeton aplikacije, ki je potreben za odobritev vaše zahteve za API.
  • 5. O X-LC-APP-Charset glava določa kodiranje znakov vaše aplikacije. API-ju omogoča, da pošlje nazaj odgovor z ustreznim kodiranjem in pravilno pretvori vaše zahteve POST in PUT v LabCollectorkodiranje znakov (ISO 8859-1).

3. API za LabCollector: Enotni identifikator vira (URI)

  • Uniformni identifikator vira (URI) je niz znakov, ki nedvoumno identificira določen vir.

  • Prepisovanje URL-ja VKLOPLJENO (mod_rewrite)
    Opomba: To morate narediti v datoteki apache.

    [PATH_DO_LABCOLLECTOR]/spletna storitev/v2/[MODUL]

  • Običajni URL-ji:

    [PATH_DO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KLJUČNA BESEDA]
  • Če želite izvedeti več o URI in kako ga uporabljati z LabCollectorProsim preberite naš priročnik LabCollector API stran 7-17.

4. Primeri API-jev

  • Primer kod v 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", žeton); request.AddHeader("Sprejmi", "besedilo/xml"); //////////////////// Odgovor IRestResponse = client.Execute(request); rezultat niza = odziv. Vsebina;
  • Primer kod v PHP: 
    ZA PREJEM INFORMACIJ O GLAVI IZ API-ja $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>
  • Primer API do pošljite datoteko: 
    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_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, $update); curl_setopt($curl, CURLO). PT_HEADER , true); //ZA PREJEM PODATKOV O GLAVI IZ API-ja $curl_exec($curl); echo($API_response);

5. LSM API

  • Lab Service Manager (LSM) je naš dodatek za storitveno jedro/testne laboratorije.
  • Kot je razloženo prej, lahko konfigurirate povezavo z dodatkom LSM (tako da označite polje pred dodatki), kot je prikazano v oddelek 1 nad.
  • API lahko uporabite za uporabo metode GET za branje/pridobivanje informacij o različnih parametrih, ki jih uporabljate v testu, kot so ime vzorca, status analize, informacije o seriji, ID opravila itd.
  • Prosim naše KB o LSM API.
  • Če želite izvedeti več o API-ju LSM in kako ga uporabljati z LabCollectorProsim preberite naš priročnik za API stran 18-28.

6. ELN API

  • Elektronski laboratorijski zvezek (ELN) dodatek nadomešča papirnati laboratorijski zvezek. 
  • Kot je razloženo prej, lahko konfigurirate povezavo z ELN dodatek (s potrditvijo polja pred dodatki, kot je prikazano v oddelek 1 nad.
  • API lahko uporabite za uporabo metod GET in POST za branje/pridobivanje informacij o podatkih knjig, poskusov in strani.
  • Prosim naše KB vklopljen ELN API.
  • Če želite izvedeti več o ELN API in kako ga uporabljati z LabCollectorProsim preberite naš priročnik ELN API stran 29-30.

7. API za potek dela *NOVO

  • Dodatek za potek dela lahko uporabljajo inštituti, ki želijo slediti strogemu protokolu preverjanja po korakih.
  • LabCollector zdaj ponuja povezavo z dodatkom za potek dela s pomočjo API-ja.
  • S pomočjo API-ja za potek dela lahko zdaj izvedete dano opravilo ali dokončate vozlišče. (vozlišče je proces ali korak v dodatku za potek dela)
  • Če želite izvedeti več o API-ju za potek dela in kako ga uporabljati z LabCollectorProsim preberite naš priročnik o API-ju Workflow.

8. Odpravljanje težav (sporočila o napakah)

9. Annex-Web service API

  • V prilogi so opisani čisti URL-ji, ki jih je treba uporabiti za pravilno delovanje.
  • V prilogi so opisani vsi URI-ji, ki jih je treba uporabiti s povezanim modulom in opisom, ter vas obvešča tudi o metodi (PUT, POST itd.), ki se uporablja za isto.
  • Motorju apache morate omogočiti uporabo URI-ja, opisanega v prilogi. Preberite ali KB naprej nastavitev spletne storitve/apache.
  • Če želite izvedeti več o API-ju LSM in kako ga uporabljati z LabCollectorProsim preberite naš priročnik za API stran 33-37.

Povezane teme: