Hyrje në LabCollector API - LabCollector

Kërkoni bazën e njohurive me fjalë kyçe

Ti je ketu:
← Të gjitha temat
PËRMBLEDHJE:

API është ndërfaqja e programimit të aplikacionit një ndërfaqe kompjuterike që përcakton ndërveprimet midis ndërmjetësve të shumëfishtë softuerësh. Me fjalë të thjeshta, lejon dy aplikacione të bisedojnë me njëri-tjetrin. Për shembull, kur përdorni ndonjë aplikacion në celularin tuaj për të parë Facebook, Instagram ose aplikacionin e motit, ju jeni duke përdorur API. Në mënyrë të ngjashme, nëse përdorni LabCollector LIMS dhe dëshironi të lidheni me softuer të palëve të treta, mund të lidheni nëpërmjet API.

La LabCollector Ndërfaqja e programimit të aplikacionit të shërbimit në ueb (API) lejon aplikacionet e palëve të treta të ndërveprojnë me të dyja LabCollectorBaza e të dhënave (modulet) dhe LabCollector shtesa (ELN dhe LSM).

AgileBio ofron API për (ato shpjegohen në seksionet e mëposhtme):-

  • API kryesore LC: Duke përdorur këtë ju mund të punoni/ekstraktoni të dhënat e moduleve (mostrat..), ruajtjen, marrjen/vendosjen e skedarëve…
  • ELN API: Kjo ju ndihmon të punoni në libra/faqe (merr/shto), të ngarkosh skedarë/imazhe
  • LSM API: Me këtë ju mund të punoni në shërbime analitike (shtoni punë, përditësoni rezultatet, merrni rezultate…)
  • WF API (I ri!): Kjo mund të ndihmojë në aktivizimin e flukseve të reja të punës, ndryshimin e statusit

API bazohet në një arkitekturë Representational State Transfer (REST) ​​që lejon aksesin në burime nëpërmjet Uniform Resource Identifier (URI) dhe veprimeve mbi to. 

API gjithashtu ofron siguri në aspektin e integritetit të të dhënave. Për shembull, kur dy aplikacione po flasin me API, ata flasin vetëm për paketat e vogla të të dhënave që janë të nevojshme. Për shembull, kur porositni një artikull nga amazon. Thjesht përcillni artikujt që dëshironi dhe më pas ju dorëzohen. Ju nuk hasni në të gjithë procesin e prodhimit ose paketimit ose transportit të artikujve, etj. Të njëjtat të dhëna në LabCollector është e dukshme vetëm në disa pjesë (burime) që mund të modifikohen me ndihmën e API.

Ndiqni këto hapa për të konfiguruar LabCollector API: -

1. Konfigurimi i përgjithshëm i API-së

2. Si të përdorni API 

3. API për LabCollector: Identifikuesi Uniform i Burimeve (URI)

4. Shembuj të API

5. LSM API

6. ELN API

7. API i rrjedhës së punës *I RI

8. Zgjidhja e problemeve (mesazhet e gabimit)

9. Annex-Web service API

1. Konfigurimi i përgjithshëm i API-së

  • Për të konfiguruar API në LabCollector ju duhet të deklaroni aplikimin tuaj në LabCollector.
  • Për ta bërë këtë, ju lutemi identifikohuni në LabCollector si një superadmin. 
    * Ju lutemi lexoni KB-në tonë për të parë në cilat janë lejet e superadminit LabCollector.
  • në LabCollector kur hyni, shkoni te ADMIN -> KONFIGURIMI -> API për SHËRBIMET WEB

  • Do të shihni faqen e mëposhtme ku mund të përcaktoni një aplikacion të ri me të cilin dëshironi të lidheni LabCollector nëpërmjet API.

 

  • 1. EMRI: Këtu mund të shtoni emrin e aplikacionit tuaj. Për shembull qëllimi, ne kemi shtuar emrin e shtesës sonë që është marrja e mostrës.
  • 2. OPERATORI I PARAKTUAR: Këtu mund të futni personin që dëshironi të jetë operatori për këtë API. Nëse nuk e shtoni operatorin këtu, atëherë do të duhet ta shtoni atë gjatë çdo kërkese që do të bëni përmes API-së.
  • 3. KUFIZIMI I IP: Ky opsion ju lejon një shtresë sigurie pasi këtu mund të përcaktoni se cilat adresa IP (protokolli interneti) lejohen të punojnë në API që po përcaktoni. Mos harroni se nëse zgjidhni "po", atëherë kutia për të futur adresën IP do të shfaqet vetëm pasi të keni ruajtur cilësimin tuaj.
  • 4. MODULET E LIDHUR ME KËTË APLIKACION: Ka 12 module si parazgjedhje të pranishme në LabCollector. Përveç kësaj, ju gjithashtu mund të krijoni shtesa të reja me porosi sipas kërkesave tuaja. Të gjitha standardet dhe modulet e personalizuara dhe shtesat do të jenë të pranishme këtu dhe ju mund të zgjidhni se cilat module dëshironi të ndërveproni me API-në.
  • 5. SHTO: Pasi të keni përcaktuar cilësimet tuaja, mund të klikoni mbi add dhe API-ja juaj do të duket si më poshtë.
  • A. Tani mund të shtoni adresën IP dhe klikoni në "Shto IP të re".
  • B. Duke klikuar ikonën e përditësimit, mund të modifikoni cilësimet tuaja të API.
  • C. Ky është numri juaj token që mund të përdoret për t'u lidhur me API. Ju madje mund të krijoni një barkod për të dhe ta kopjoni duke klikuar mbi ikonë.
 SHËNIM: Shënim: Për të përdorur këtë veçori, duhet të aktivizoni Curl në preferencat tuaja PHP. Në Linux, instaloni paketën PHP-Curl. Në Windows dhe me instaluesin tonë automatik, modifikoni PHP.ini dhe hiqni komentet për Curl (extension=php_curl.dll).

2. Si të përdorni API 

  • Dialogu i komunikimit ndërmjet aplikacioneve në distancë (të palëve të treta) dhe LabCollector bazohet në protokollin HTTP 1.1. (*Për të kontrolluar se çfarë është burimi, shihni imazhin e mësipërm)

  • Ju mund të modifikoni, lexoni, krijoni ose fshini një burim duke përdorur GET, POST, PUT dhe DELETE metodë siç tregohet në imazhin e mësipërm.
  • Ju mund të kërkoni një modifikim dhe më pas të merrni përgjigjen për modifikimin siç shpjegohet më poshtë.
  • Për shembull qëllimi, ne kemi përdorur Aplikacioni POSTMAN Mjet për API dhe ndërfaqja duket si më poshtë.

  • Siç mund ta shihni në imazhin e mësipërm, mund të shkruani URL-në e API-së (për shembull lidhja me LabCollector's Moduli Strains & Cells) dhe pasi të keni përfunduar modifikimet dhe të shtypni dërgoni do të merrni një përgjigje.
    Nëse gjithçka është e saktë dhe kërkesa është kryer, atëherë përgjigja do të duket si më poshtë në aplikacionin Postman.
  • 1. Këtu mund të zgjidhni metodën e kërkesës suaj. (MERRNI, POSTOJO, VENDO dhe FSHI)
  • 2. Një kërkesë për API kërkon disa HTTP/HTTPS specifike kokat.
  • 3. La pranoj header përcakton formatin e dëshiruar të përgjigjes së kërkesës suaj, tekstit/XML (parazgjedhur) ose aplikacionit/JSON.
  • 4. La X-LC-APP-Auth kreu ku vendosni tokenin tuaj të aplikacionit i cili është i nevojshëm për të autorizuar kërkesën tuaj në API.
  • 5. La X-LC-APP-Set header përcakton kodimin e karaktereve të aplikacionit tuaj. Ai lejon API-në të dërgojë përgjigjen me kodimin e duhur dhe të konvertojë saktë kërkesat tuaja POST dhe PUT në LabCollectorkodimi i karaktereve (ISO 8859-1).

3. API për LabCollector: Identifikuesi uniform i burimit (URI)

  • Një Identifikues Uniform i Burimeve (URI) është një varg karakteresh që identifikon pa mëdyshje një burim të caktuar.

  • URL Rishkruaj AKTIV (mod_rewrite)
    Shënim: Ju duhet ta bëni këtë në skedarin tuaj apache.

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]

  • URL-të normale:

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?emri=[Fjala kyçe]
  • Për të ditur më shumë rreth URI-së dhe si ta përdorni me të LabCollector, ju lutem lexoni manualin tonë LabCollector API faqe 7-17.

4. Shembuj të API

  • Shembull i kodeve në C# 
    string url = _Url.Replace("{id}", txtDataID.Text); var klient = i ri RestSharp.RestClient(url); klienti.Timeout = 900000; var kërkesë = e re RestSharp.RestRequest(); kërkesë.Timeout = 900000; kërkesë.Metod = Metoda.GET; kërkesa.AddHeader("X-LC-APP-Auth", token); request.AddHeader("Prano", "tekst/xml"); /////////////////// Përgjigja IRestResponse = klienti.Ekzekutoni(kërkesën); rezultati i vargut = përgjigje.Përmbajtja;
  • Shembull i kodeve në PHP: 
    PËR TË MARRË TË DHËNA TË HEADER NGA API $API_response = curl_exec($curl); curl_close ($curl); jehonë $API_response; ?>
  • Shembull i API në dërgoni një skedar: 
    labcollector.rar'; $file_info = getimagesize($file_rruga); $madhësia e skedarit = madhësia e skedarit ($shtegu i skedarit); $update = grup( '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, grup ('X-LC-APP-Auth: TOKEN', 'Lloji i përmbajtjes: '.$file_info['mime')) ; LOPT_HEADER , true //OPTIONAL -> PËR TË MARRË INFO NGA API-ja $API = curl_exec($curl_close($curl);

5. LSM API

  • Lab Service Manager (LSM) është shtesa jonë për laboratorët bazë të shërbimit/test.
  • Siç u shpjegua më parë, mund të konfiguroni për t'u lidhur me shtesën LSM (duke kontrolluar kutinë përpara shtesave) siç tregohet në seksioni 1 më sipër.
  • Ju mund të përdorni API për të përdorur metodën GET për të lexuar/marr informacion në lidhje me parametra të ndryshëm që përdorni në një test si emri i mostrës, statusi i analizës, informacioni i grupit, ID-ja e punës, etj.
  • Ju lutemi tonë KB në LSM API.
  • Për të ditur më shumë rreth LSM API dhe si ta përdorni me të LabCollector, ju lutem lexoni manualin tonë në API faqe 18-28.

6. ELN API

  • Fletore Laboratori Elektronik (ELN) shtesa është zëvendësimi i një fletoreje laboratori letre. 
  • Siç u shpjegua më parë, mund të konfiguroni për t'u lidhur me ELN shtesa (duke kontrolluar kutinë përpara shtesave siç tregohet në seksioni 1 më sipër.
  • Ju mund të përdorni API për të përdorur metodën GET dhe POST për të lexuar/marr informacion rreth të dhënave të librave, eksperimenteve dhe faqeve.
  • Ju lutemi tonë KB ndezur ELN API.
  • Për të ditur më shumë rreth ELN API dhe si ta përdorni me të LabCollector, ju lutem lexoni manualin tonë ELN API faqe 29-30.

7. API e rrjedhës së punës *I RI

  • Shtesa e rrjedhës së punës mund të përdoret nga institutet që duan të ndjekin një protokoll të rreptë të verifikimit hap pas hapi.
  • LabCollector tani ofron lidhjen me shtesën e rrjedhës së punës me ndihmën e API.
  • Me ndihmën e API-së së rrjedhës së punës, tani mund të ekzekutoni një punë të caktuar ose të plotësoni një nyje. (një nyje është një proces ose hap në shtesën e rrjedhës së punës)
  • Për të ditur më shumë rreth API-së së rrjedhës së punës dhe si ta përdorni me të LabCollector, ju lutem lexoni manualin tonë mbi API të Workflow.

8. Zgjidhja e problemeve (mesazhet e gabimit)

9. Aneks-Ueb shërbim API

  • Shtojca përshkruan URL-të e pastra që do të përdoren për të funksionuar siç duhet.
  • Shtojca përshkruan të gjitha URI-të që do të përdoren me modulin dhe përshkrimin përkatës dhe gjithashtu ju informon për metodën (PUT, POST, etj) që do të përdoren për të njëjtën gjë.
  • Duhet të aktivizoni motorin apache që të përdorë URI-në e përshkruar në aneks. Lexoni ose KB në konfigurimi i uebservice/apache.
  • Për të ditur më shumë rreth LSM API dhe si ta përdorni me të LabCollector, ju lutem lexoni manualin tonë në API faqe 33-37.

Temat e ndërlidhura: