Увод у LabCollector АПИ - LabCollector

Претражите базу знања по кључној речи

Ви сте овде:
← Све теме
РЕЗИМЕ:

АПИ је интерфејс за програмирање апликације, рачунарски интерфејс који дефинише интеракције између више софтверских посредника. Једноставним речима, омогућава две апликације да разговарају једна са другом. На пример, када користите било коју апликацију на свом мобилном телефону да бисте видели Фацебоок, Инстаграм или апликацију за временску прогнозу, користите АПИ. Слично, ако користите LabCollector ЛИМС и желите да се повежете са софтвером треће стране, можете се повезати преко АПИ-ја.

LabCollector Интерфејс за програмирање апликација веб сервиса (АПИ) омогућава апликацијама трећих страна да комуницирају са оба LabCollector'с база података (модули) и LabCollector додаци (ELN и ЛСМ).

АгилеБио нуди АПИ за (они су објашњени у одељцима испод): -

  • Главни ЛЦ АПИ: Користећи ово можете радити/извлачити податке модула (узорке..), складиштити, преузимати/стављати датотеке…
  • ELN АПИ за: Ово вам помаже да радите на књигама/страницама (добијете/додајте), отпремате датотеке/слике
  • ЛСМ АПИ: Са овим можете радити на аналитичким/услугама (додавати послове, ажурирати резултате, добити резултате…)
  • ВФ АПИ (Нев!): Ово може помоћи у покретању нових токова посла, промени статуса

АПИ је заснован на архитектури Репресентатионал Стате Трансфер (РЕСТ) која омогућава приступ средства кроз Униформ Ресоурце Идентифиер (УРИ) и акције на њима. 

АПИ такође пружа сигурност у смислу интегритета података. На пример, када две апликације разговарају са АПИ-јем, оне разговарају само у смислу малих пакета података који су неопходни. На пример, када наручите артикал са Амазона. Ви само пренесите ставке које желите и онда вам се испоручују. Не наилазите на цео процес производње предмета или паковања или транспорта итд. Исти подаци у LabCollector видљив је само у неким деловима (ресурсима) који се могу мењати уз помоћ АПИ-ја.

Пратите ове кораке да бисте конфигурисали LabCollector АПИ:-

1. Опште подешавање АПИ-ја

2. Како користити АПИ 

3. АПИ за LabCollector: јединствени идентификатор ресурса (УРИ)

4. Примери АПИ-ја

5. ЛСМ АПИ

6. ELN АПИ за

7. АПИ тока рада *НОВА

8. Решавање проблема (поруке о грешци)

9. АПИ за Анекс-Веб сервис

1. Опште подешавање АПИ-ја

  • Да бисте конфигурисали АПИ у LabCollector морате пријавити своју пријаву у LabCollector.
  • Да бисте то урадили, пријавите се на LabCollector као суперадмин. 
    * Молимо прочитајте нашу КБ да видите у чему су суперадминистраторске дозволе LabCollector.
  • У LabCollector када се пријавите идите на АДМИН -> ПОСТАВИТИ -> ВЕБ СЕРВИЦЕС АПИ

  • Видећете страницу испод на којој можете да дефинишете нову апликацију на коју желите да се повежете LabCollector преко АПИ-ја.

 

  • 1. ИМЕ: Овде можете додати назив ваше апликације. На пример, у сврху, додали смо назив нашег додатка који прима узорак.
  • 2. ДЕФАУЛТ ОПЕРАТОР: Овде можете да унесете особу којој желите да буде оператер за овај АПИ. Ако овде не додате оператора, мораћете да га додате током сваког захтева који будете упутили преко АПИ-ја.
  • 3. ИП ОГРАНИЧЕЊЕ: Ова опција вам омогућава ниво безбедности јер овде можете да дефинишете које ИП адресе (интернет протокол) смеју да раде на АПИ-ју који дефинишете. Запамтите да ако одаберете „да“, онда ће се поље за унос ИП адресе појавити тек након што сачувате своје подешавање.
  • 4. МОДУЛИ ПОВЕЗАНИ НА ОВУ АПЛИКАЦИЈУ: Постоји 12 подразумевано присутних модула LabCollector. Осим тога, можете креирати и нове прилагођене додатке према вашим захтевима. Овде ће бити присутни сви подразумевани и прилагођени модули и додаци и можете изабрати које модуле желите да комуницирате са АПИ-јем.
  • 5. АДД: када дефинишете своја подешавања, можете кликнути на додај и ваш АПИ ће изгледати као испод.
  • A. Сада можете додати ИП адресу и кликнути на „Додај нову ИП адресу“.
  • B. Кликом на икону ажурирања можете да измените подешавања АПИ-ја.
  • C. Ово је ваш број токена који се може користити за повезивање на АПИ. Можете чак креирати бар код за њега и копирати га кликом на икона.
 НАПОМЕНЕ: Напомена: Да бисте користили ову функцију, потребно је да активирате Цурл у вашим ПХП преференцама. У Линук-у, инсталирајте ПХП-Цурл пакет. На Виндовс-у и са нашим аутоматским инсталатером, уредите ПХП.ини и декоментирајте екстензије за Цурл (ектенсион=пхп_цурл.длл).

2. Како користити АПИ 

  • Комуникациони дијалог између удаљених апликација (треће стране) и LabCollector је заснован на ХТТП 1.1 протоколу. (*Да бисте проверили шта је ресурс погледајте слику изнад)

  • Можете да мењате, читате, креирате или бришете ресурс користећи ГЕТ, ПОСТ, ПУТ и ДЕЛЕТЕ метод као што је приказано на горњој слици.
  • Можете затражити измену, а затим добити одговор за измену као што је објашњено у наставку.
  • На пример, користили смо ПОШТАР апликација Алатка за АПИ и интерфејс изгледа као испод.

  • Као што можете видети на горњој слици, можете да унесете АПИ УРЛ (на пример везу до LabCollector'с Страинс & Целлс модул) и након што завршите са модификацијама и притиснете сенд, добићете одговор.
    Ако је све исправно и захтев је обављен онда ће одговор изгледати као испод у апликацији Постман.
  • 1. Овде можете изабрати метод вашег захтева. (УЗМИ, ПОСТАВИ, ПОСТАВИ и ИЗБРИШИ)
  • 2. Захтев за АПИ захтева одређени ХТТП/ХТТПС заглавља.
  • 3. прихватити заглавље дефинише жељени формат одговора вашег захтева, текст/КСМЛ (подразумевано) или апликацију/ЈСОН.
  • 4. Кс-ЛЦ-АПП-Аутх заглавље где стављате свој токен апликације који је неопходан за ауторизацију вашег захтева АПИ-ју.
  • 5. Кс-ЛЦ-АПП-Цхарсет заглавље дефинише кодирање знакова ваше апликације. Омогућава АПИ-ју да врати одговор са одговарајућим кодирањем и да исправно конвертује ваше ПОСТ и ПУТ захтеве у LabCollector'с кодирање знакова (ИСО 8859-1).

3. АПИ за LabCollector: Униформни идентификатор ресурса (УРИ)

  • Униформни идентификатор ресурса (УРИ) је низ знакова који недвосмислено идентификује одређени ресурс.

  • УРЛ Реврите ОН (мод_реврите)
    Белешка: Ово морате да урадите у својој апацхе датотеци.

    [ПАТХ_ТО_LABCOLLECTOR]/вебсервице/в2/[МОДУЛ]

  • Нормалне УРЛ адресе:

    [ПАТХ_ТО_LABCOLLECTOR]/вебсервице/в2/[МОДУЛЕ]?наме=[КЕИВОРД]
  • Да бисте сазнали више о УРИ-ју и како га користити LabCollector, Молимо вас прочитајте наш приручник LabCollector АПИ за страна 7-17.

4. Примери АПИ-ја

  • Пример кодова у C# 
    стринг урл = _Урл.Реплаце("{ид}", тктДатаИД.Тект); вар клијент = нови РестСхарп.РестЦлиент(урл); цлиент.Тимеоут = 900000; вар рекуест = нев РестСхарп.РестРекуест(); рекуест.Тимеоут = 900000; рекуест.Метход = Метход.ГЕТ; рекуест.АддХеадер("Кс-ЛЦ-АПП-Аутх", токен); рекуест.АддХеадер("Прихватам", "текст/кмл"); //////////////////// ИРестРеспонсе респонсе = цлиент.Екецуте(рекуест); стринг резултат = одговор.Садржај;
  • Пример кодова у PHP: 
    ДА ДОБИЈЕТЕ ИНФОРМАЦИЈЕ О ЗАГЛАВЉУ ИЗ АПИ-ја $АПИ_респонсе = цурл_екец($цурл); цурл_цлосе($цурл); ецхо $АПИ_респонсе; ?>
  • Пример АПИ за до послати датотеку: 
    labcollector.рар'; $филе_инфо = гетимагесизе($филе_патх); $филе_сизе = величина датотеке($путања_датотеке); $упдате = арраи( 'хеалтх_репорт_филе[0]' => '@'.$филе_патх.";филенаме=зз_labcollector.рар;типе=апплицатион/к-рар-цомпрессед", 'хеалтх_репорт_филе[1]' => '@'.$филе_патх2.";филенаме=зз_labcollector2.рар;типе=апплицатион/к-рар-цомпрессед", 'уплоад_моде' => 'адд' ); $цурл = цурл_инит(); цурл_сетопт($цурл, ЦУРЛОПТ_ХТТПХЕАДЕР, арраи('Кс-ЛЦ-АПП-Аутх: ТОКЕН, 'Цонтент-Типе: '.$филе_инфо['миме'])($цурл, ЦУРЛОПТ_УРЛ, $урл_сетопт($цурл, ЦУРЛОПТ_РЕТУРНТРАНСФЕР, труе) цурл_сетопт ($цурл, ЦУРЛОПТ_ЦУСТОМРЕКУЕСТ, "ПУТ"); ПТ_ХЕАДЕР , труе //ОПЦИОНАЛНО -> ДА БИСТЕ ПРИМИЛИ ИНФОРМАЦИЈУ ОД АПИ-ја $АПИ_респонсе = цурл_цлосе($цурл);

5. ЛСМ АПИ

  • Лаб Сервице Манагер (ЛСМ) је наш додатак за лабораторије за језгро услуга/тестирање.
  • Као што је објашњено раније, можете да конфигуришете да се повежете са ЛСМ додатком (тако што ћете означити поље испред додатака) као што је приказано на одељак КСНУМКС горе.
  • Можете да користите АПИ да бисте користили ГЕТ метод за читање/преузимање информација о различитим параметрима које користите у тесту као што су назив узорка, статус теста, информације о серији, ИД посла, итд,
  • Молимо наше КБ на ЛСМ АПИ-ју.
  • Да бисте сазнали више о ЛСМ АПИ-ју и како га користити LabCollector, Молимо вас прочитајте наш приручник о АПИ-ју страна 18-28.

6. ELN АПИ за

  • Електронска лабораторијска свеска (ELN) додатак је замена папирне лабораторијске свеске. 
  • Као што је објашњено раније, можете конфигурисати да се повежете на ELN додатак (тако што ћете означити поље испред додатака као што је приказано у одељак КСНУМКС горе.
  • Можете да користите АПИ за коришћење метода ГЕТ и ПОСТ за читање/преузимање информација о подацима књига, експеримената и страница.
  • Молимо наше КБ укључен ELN АПИ.
  • Да бисте сазнали више о ELN АПИ и како га користити са LabCollector, Молимо вас прочитајте наш приручник ELN АПИ за страна 29-30.

7. Воркфлов АПИ *НОВА

  • Додатак за радни ток могу да користе институти који желе да прате строги протокол валидације корак по корак.
  • LabCollector сада нуди повезивање са додатком тока посла уз помоћ АПИ-ја.
  • Уз помоћ АПИ-ја тока посла сада можете извршити дати посао или завршити чвор. (чвор је процес или корак у додатку тока посла)
  • Да бисте сазнали више о АПИ-ју тока посла и како да га користите LabCollector, Молимо вас прочитајте наш приручник за Воркфлов АПИ.

8. Решавање проблема (поруке о грешци)

9. Аннек-Веб сервис АПИ

  • Додатак описује чисте УРЛ адресе које треба користити за правилно функционисање.
  • Додатак описује све УРИ-је који ће се користити са повезаним модулом и описом и такође вас информише о методи (ПУТ, ПОСТ, итд.) који ће се користити за исти.
  • Морате да омогућите апацхе машину да користи УРИ описан у Анексу. Прочитајте или укључите КБ подешавање веб сервиса/апача.
  • Да бисте сазнали више о ЛСМ АПИ-ју и како га користити LabCollector, Молимо вас прочитајте наш приручник о АПИ-ју страна 33-37.

Повезане теме: