Neach-cruinneachaidh Lab Web Stiùireadh Cleachdaiche Bathar-bog Prògramadh Iarrtas Seirbheis Eadar-aghaidh Bathar-bog

Tionndadh 2.0 - Samhain 2021
Web Bathar-bog eadar-aghaidh prògramadh tagradh seirbheis
Stiùireadh Cleachdaiche

Web Bathar-bog eadar-aghaidh prògramadh tagradh seirbheis

RO-RÀDH

An LabCollector Web Tha Eadar-aghaidh Prògramadh Iarrtas Seirbheis (API) a’ leigeil le tagraidhean treas-phàrtaidh eadar-obrachadh le stòr-dàta LabCollector (modalan) agus tuilleadan (ELN agus LSM).
Tha an API stèidhichte air ailtireachd Gluasad Stàite Riochdachail (REST) ​​a’ toirt cothrom air goireasan tro Aithneadair Goireasan Èideadh (URI) agus gnìomhan orra.
Thoir an aire: Bhon Ògmhios chaidh 2017 API v1 a stad agus tha a h-uile mean-fhàs ùr ann an API v2.

LABCOLLECTOR API

2-1. Suidheachadh API
An toiseach, feumaidh tu an tagradh agad fhoillseachadh anns a’ bhathar-bog LabCollector agad. Gus faighinn chun fhoirm rèiteachaidh dearbhaidh tagraidh, log a-steach gu LabCollector le còraichean sàr-rianaire agus rach gu Admin> Setup duilleag. An uairsin tagh an Web Ceangal API seirbheis. Tha thu a-nis air an Web Duilleag stiùireadh aplacaidean API seirbheis. Gus iarrtas ùr fhoillseachadh, dìreach lìon am foirm seo:

• Ainm: ainm an tagraidh agad.
• Modalan ceangailte ris an aplacaid seo: tagh modalan anns am faigh an aplacaid cothrom air.
• Gnìomhaiche bunaiteach: tagh an neach-conaltraidh a bhios mar an gnìomhaiche bunaiteach mura h-eil thu airson am fiosrachadh seo a chuir a-steach anns gach iarrtas.
• Cuingealachadh IP: Leigidh an roghainn tèarainteachd leat liosta de sheòlaidhean IP fhoillseachadh, a leigeas leat iarrtasan a dhèanamh air an API.

Tha liosta nan tagraidhean a’ sealltainn a h-uile aplacaid airson do LabCollector agus faodaidh tu, aig àm sam bith, an raon aca atharrachadh.
Tha cothrom agad cuideachd air an Token a tha riatanach gus an tagradh agad a chomharrachadh rè iarrtasan don API.

Thoir an aire: Gus am feart seo a chleachdadh, feumaidh tu Curl air na roghainnean PHP agad. Ann an Linux, stàlaich am faidhle PHP-Curl paca.
Air uinneagan agus leis an stàlaichear fèin-ghluasadach againn, deasaich PHP.ini agus leudachaidhean gun iomradh airson Curl (leudachadh = php_curl.dll).
2-2. Iarrtasan
An còmhradh eadar tagraidhean treas-phàrtaidh agus an LabCollector web Tha seirbheis API stèidhichte air protocol HTTP 1.1.
2-2-1. Modh API
Faodaidh tu iarrtasan HTTP no HTTPS a chuir chun an web seirbheis le dòigh air goireas a chuir an gnìomh.

• GET dòigh airson goireas a leughadh
• Dòigh POST airson goireas ùr a chruthachadh
• Modh PUT airson goireas atharrachadh
• DÌON modh airson goireas a sguabadh às

2-2-2. Cinn-cinn
Feumaidh iarrtas don API cinn-cinn HTTP/HTTPS sònraichte:

• Tha an bann-cinn Gabhail a’ mìneachadh an cruth freagairt a tha thu ag iarraidh san iarrtas agad, teacsa/XML, no tagradh/JSON.
• Is e bann-cinn X-LC-APP-Auth far an cuir thu an comharra tagraidh agad a tha riatanach gus d’ iarrtas a cheadachadh don API.
• Bidh bann-cinn X-LC-APP-Charset a’ mìneachadh còdachadh caractar an tagraidh agad. Leigidh e leis an API am freagairt a chuir air ais leis a’ chòdachadh iomchaidh agus na h-iarrtasan POST is PUT agad a thionndadh gu còdachadh caractar LabCollector (ISO 8859-1).

2-2-3. Inneal
Faodaidh tu feuchainn ri dàta fhaighinn air ais no dàta a chuir chun API le app bathar-bog mar Postman (https://www.getpostman.com/).

Aithniche Ghoireasan Èideadh (URI)

2-3-1. GET meatod
Coitcheann
Tha gach dàta modal LabCollector air a chomharrachadh le URI sònraichte (faic an leas-phàipear airson liosta iomlan de URI a’ mhodal):
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] Bidh an t-iarrtas seo a’ freagairt liosta an dàta gu lèir ann am modal.
Faodaidh tu sgrùdadh a dhèanamh air dàta modal le bhith a’ cur paramadairean ris an URI agad. Faodaidh tu a dhol seachad air paramadair le prìomh fhacal a tha co-chosmhail ri luach raoin, mar: [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[PRÌOMH ORD] me
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=A' chiad chlàr %20
Bidh an t-iarrtas seo a’ tilleadh na clàran far a bheil am prìomh fhacal “Ciad Chlàr” anns an luach ainm aca.
Is iad sin cuid de pharaimearan àbhaisteach a bhios an API a’ cleachdadh gus gnìomhan sgrùdaidh is sìolaidh a dhèanamh.
Paramadairean gnàthaichte

• Am paramadair record_id gus dàta a shònrachadh leis an ID aige:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?record_id=[RECORD_ID]
me [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?record_id=1,19
Tillidh an t-iarrtas seo clàran le ID 1 agus ID 19. Faodaidh tu iomadh ID a shònrachadh le bhith gan sgaradh le cromag.

• Bidh am paramadair by_keywords a’ dèanamh sgrùdadh prìomh fhaclan:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD]
me [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords= cealla
Nì an t-iarrtas seo sgrùdadh air a h-uile raon de gach clàr agus tillidh e ceallan a tha a’ maidseadh. Faodaidh tu grunn phrìomh fhaclan a shònrachadh le bhith gan sgaradh le cromag.

• Bidh am paramadair by_keywords a’ dèanamh sgrùdadh prìomh fhaclan:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD]
me [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords= cealla
Nì an t-iarrtas seo sgrùdadh anns a h-uile raon anns a h-uile clàr agus tillidh e cealla co-fhreagarrach. Faodaidh tu grunn phrìomh fhaclan a shònrachadh le bhith gan sgaradh le cromag.

• Paramadairean nan raointean, Ma tha thu airson dìreach cuid de luachan raointean fhaighinn air ais ann am freagairt API:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=[FIELD1],[FIELD2]
me [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=count,name
Tillidh an t-iarrtas seo a h-uile clàr bhon mhodal ach le dìreach raointean cunntais is ainmean. Faodaidh tu iomadh raon a shònrachadh le bhith gan sgaradh le cromag.
Tha an t-iarrtas a-nis a’ gabhail ri grunn luachan air an sgaradh le cromag, airson raointean àbhaisteach den t-seòrsa “tagh”

• Leigidh am paramadair search_on leat dàta a lorg. Agus faodaidh tu a chleachdadh airson sgrùdadh a rèir raon cinn-latha mar a leanas:

[PATH_TO_LABCOLLECTOR]/webseirbheis/v2/[MODULE]&
search_on=date_field&from=XXXXXX&gu=ZZZZZZ
Mura cleachd thu ach FROM, bheir an toradh a h-uile ceann-latha nas motha na an ceann-latha FROM. Mura cleachd thu ach cuideachd, tillidh e an luach gu lèir chun a’ chinn-latha seo.

• Leigidh am paramadair sort_by leat do rannsachadh a sheòrsachadh:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=[FIELD1]_DESC
me [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]? sort_by=name_DESC
Bidh an t-iarrtas seo a’ tilleadh a h-uile clàr a chaidh a sheòrsachadh ann an òrdugh teàrnaidh air raon an ainm. 'S urrainn dhut iomadh sort_a shònrachadh le bhith gan sgaradh le cromag agus òrdugh ainmichte ascendant _ASC" no sliochd "_DESC" airson gach raon.

• Leigidh am paramadair limit_to leat an àireamh de thoraidhean a chuingealachadh:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?limit_to=0,10
Bidh an t-iarrtas seo a' tilleadh 10 clàran a' tòiseachadh aig clàr-amais 0. Mura sònraich thu an clàr-amais, cha tèid ach an àireamh de thoraidhean comharraichte a thilleadh.
Bidh an API cuideachd a’ tilleadh dà raon gnàthaichte san fhreagairt bann-cinn, “X-LC-QUERY-RESULT” anns a bheil an àireamh de thoraidhean a chaidh a thilleadh ann am freagairt na cuirp agus “X-LC-QUERY- TOTAL” anns a bheil na clàran gu lèir a fhreagras air an rannsachadh agad.
Tha URI sònraichte aig gach clàr cuideachd:
[PATH_TO_LABCOLLECTOR]/webseirbheis/v2/[MODULE]/[DATA_ID]
This request replies a unique record. [DATA_ID] must match the unique ID of the record you want to retrieve.
Stòradh
Tha gnìomhan sìoltachaidh Tube Soter agad cuideachd airson gach nì ceangailte ri stòradh:
[PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=[BOX_ID]
me [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=34
Bidh an t-iarrtas seo a’ tilleadh fiosrachadh stòraidh air bogsa ID 34 mar rèitiche tiùba. Faodaidh tu iomadh ID a shònrachadh le bhith gan sgaradh le cromag.

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=[BOX_ID]&record_name=[RECORD_NAME]
me [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=206&record_name=ST-260
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=[RECORD_NAME]
me [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=ST-260
Bidh na h-iarrtasan sin a’ sìoladh air clàr leis an t-ainm ST-260. Faodaidh tu ainmean ioma-chlàran a shònrachadh le bhith gan sgaradh le cromag. 'S urrainn dhut ID a' bhogsa a shònrachadh cuideachd, an seo 206.[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=[BOX_NAME]
me [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=test-rack_06
Nì an t-iarrtas seo criathradh air bogsa test-rack_06. Faodaidh tu grunn ainmean bogsa a shònrachadh le bhith gan sgaradh le cromag.
Faodaidh paramadairean rannsachaidh eile gu action=tube_sorter a bhith:

• location_id
• ionad_ainm
• goireas_id
• goireas_ainm
  Tillidh e bogsaichean falamh cuideachd.
• Tha am paramadair storage_sec a’ ceadachadh fiosrachadh fhaighinn air ais mu stòradh àrd-sgoile.

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]&data_id=[DATA_ID]&fields=stòradh_sec

Crann toraidh

• Tha an gnìomh get lot a’ ceadachadh fiosrachadh fhaighinn air ais lot agus reagent

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&lo t_id=1/LT
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&ch em_id=2
Is e paramadairean roghainneil lot_id (ann an cruth 1 no 1/LT) agus chem_id. Mura faigh e crìochan, gheibh e air ais a h-uile crann gnìomhach.
Reasabaidh
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe s
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=[record_id]
me [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=509
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action= Logaichean getRecipe
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=[record_id]
me [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=1218
Tha IDan examples ach tha iad èigneachail anns na gairmean sin.
faigh reasabaidhean clò-bhuail am fiosrachadh a leanas: id, ainm, tuairisgeul, roinn

faigh reasabaidhean clò-bhuail am fiosrachadh a leanas airson an reasabaidh_id sin: id, ainm, tuairisgeul, roinn, agus an uairsin na pàirtean Bidh getRecipeLogs a’ clò-bhualadh an fhiosrachaidh a leanas: id, ainm, tuairisgeul, roinn Bidh getRecipeReport a’ clò-bhualadh na h-aithisg PDF airson an log_id sin fon chruth base64 a ghabhas a chòdachadh gu PDF.

2-3-2. Modh POST
Gus goireas ùr a chruthachadh, dìreach cuir iarrtas leis an dòigh POST chun mhodal URI a tha thu ag iarraidh:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]
Your parameter keys have to match the field’s name.
Thoir sùil airson raointean àraid a chaidh a chur ris, nuair a chruthaicheas tu clàran ùra (POST) no ùrachadh (PUT)
Ma tha clàr eadar-dhealaichte ann leis an aon luach airson raon gun samhail, cha chuir API crìoch air a’ ghnìomhachd agus tillidh e còd 409 (Còmhstri), agus feumaidh an teacsa: Luach airson raon ‘XXX’ a bhith gun samhail. Tha luach ‘YYY’ mu thràth sa chlàr ‘ZZZ’. (faic dealbh-sgrìn) 

Thoir an aire: faodar raon project_code a chleachdadh ann am POST agus PUT agus tha dùil aige ri teacsa (chan e id). Faodaidh tu a-nis còd pròiseict ùr a chruthachadh mura h-eil e ann agus ma tha cead gu leòr aig a’ ghnìomhaiche (rianadair no sàr-rianaire).

• Leigidh an gnìomh addBox leat bogsa a chruthachadh

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action= addBox

• Paramadairean riatanach:
  o ainm
  o seòrsa (feumaidh seo a bhith na sheòrsa dligheach: bogsa, box_nogrid, truinnsear, microplate, tadhal be, poca, pàirt sgeilp)
  o uidheamachd (a’ toirt taic do id no ainm agus feumaidh e a bhith ann an stòradh LabCollector).
  o meud (an urra ris an t-seòrsa bogsa: bu chòir a bhith àireamhach airson tadhal, agus an cruth (A: 1.H: 8) airson bogsa, truinnsear, agus microplate)
• Paramadairean roghainneil:
  o tuairisgeul
  o racais
  o neach-gleidhidh

2-3-3. Modh PUT
Gus goireas atharrachadh, dìreach cuir iarrtas leis an dòigh PUT chun chlàr URI a tha thu ag iarraidh:
[PATH_TO_LABCOLLECTOR]/webseirbheis/v2/[MODULE]/[DATA_ID]
Your parameter keys have to match the field’s name you want to modify.
Airson na gnìomhan a leanas, thoir an aire, airson iarrtasan PUT, gum feum paramadairean a bhith air a’ bhodhaig (chan ann anns a’ bhodhaig). URL).
Tha an URL tha [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2
Is iad na cinn-cinn: X-LC-APP-Auth, Gabh ris.

• Thoir air falbh Tomhas
  - Paramadairean:
  o thoir air falbhVolume (riatanach)
  o còd-bàr, còd sònraichte_, no còd-barra aliquot (feumaidh fear dhiubh a bhith an làthair)
  o meud (riatanach)
  - Freagairt: OK
  
• Thoir air falbh Stòradh
  - Paramadairean:
  o stòradh iomallach (riatanach)
  o còd-bàr, còd sònraichte_, no còd-barra aliquot (feumaidh fear dhiubh a bhith an làthair)
  - Freagairt: OK
  
• Cuir a-steach Leabhar Clàraidh
  – URL:
  [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&module=[m odule]
  - Paramadairean:
  o addRegistryBook (riatanach)
  o record_id (riatanach)
  o ceann-latha (èigneachail, cruth yy yy/mm/dd no yyyy-mm-dd)
  o beachdan (riatanach)
  o gnìomhaiche (roghainneil, mura cuir e an gnìomhaiche bunaiteach API thèid a chleachdadh)
  o gnìomh (roghainneil, feumaidh 'Seòrsa Gnìomh Stòraidh' dligheach a bhith air a mhìneachadh ann an LC
  > Rianachd > Roghainnean > Seòrsa Pròiseas & Gnìomhan)
  - Freagairt: OK
  
• Cuir stòradh àrd-sgoile ris
  - Paramadairean:
  o cuir stòradh àrd-sgoile (èigneachail)
  o còd-barra (riatanach)
  o box_id (riatanach)
  o box_details (riatanach a-mhàin airson a’ bhogsa le roinneadh clèithe, treidhe tiùba, agus microplate. Ma tha am bogsa às aonais cliath, poca, tadhal no pàirt sgeilp, chan eil feum air)
  o unique_code (roghainneil)
  o tomhas-lìonaidh (roghainneil)
  o beachdan (roghainneil)
  o cap_color (roghainneil)

Thoir an aire: Thèid teachdaireachd mearachd a thilleadh mura h-eil crìochan èigneachail an làthair; mura h-eil an còd-barra ann; ma tha an unique_code an làthair, ach chan eil e gun samhail; agus, ma tha an dath an làthair ach nach eil e ann.
Mura faighear am paramadair box_details agus gu feum an seòrsa bogsa suidheachadh (bogsa le cliath, treidhe tiùba, no microplate), thèid teachdaireachd mearachd a thilleadh. Thoir an aire: faodar raon project_code a chleachdadh ann am POST agus PUT agus tha dùil aige ri teacsa (chan e id). Faodaidh tu a-nis còd pròiseict ùr a chruthachadh mura h-eil e ann agus ma tha cead gu leòr aig a’ ghnìomhaiche (rianadair no sàr-rianaire).
2-3-4. DÙTHCHAS modh
Gus goireas a dhubhadh às, dìreach cuir iarrtas leis an dòigh DELETE chun chlàr URI a tha thu ag iarraidh:
[PATH_TO_LABCOLLECTOR]/webseirbheis/v2/[MODULE]/[DATA_ID]

TEISTEANASAN Mearachd API

LABCOLLECTOR WEB SERVICE API - Leas-phàipear

Tha siostam URI an API a 'cleachdadh sìmplidh agus glan URL. Dèan cinnteach gun leig thu leis an einnsean ath-sgrìobhaidh bho Apache an URI air a bheil iomradh sa chlàr a leanas a chleachdadh. Mura cuir am frithealaiche LabCollector taic ris an einnsean ath-sgrìobhaidh cleachd an làn URL pàtran airson an iarrtas agad (àrd-sgoil URL de gach loidhne).

http://www.labcollector.comsales@agilebio.com
AgileBio Na Stàitean Aonaichte
5473 Kearny Villa Road Suite 255
San Diego, CA 92123
Na Stàitean Aonaichte
Fòn: 347 368 1315
Facs: (800) 453 9128
http://www.agilebio.com
Prìomh Oifis AgileBio
75 rue de Lourmel
75015 Paris
AN FHRAING
Fòn: 01 41 79 15 85
Facs: 01 72 70 40 22