Որոնել գիտելիքների բազան ըստ հիմնաբառի
ԱՄՓՈՓՈՒՄ:
API-ն կիրառական ծրագրավորման ինտերֆեյս է, որը հաշվողական ինտերֆեյս է, որը սահմանում է բազմաթիվ ծրագրային միջնորդների փոխազդեցությունները: Պարզ բառերով այն թույլ է տալիս երկու հավելվածների խոսել միմյանց հետ: Օրինակ, երբ դուք օգտագործում եք որևէ հավելված ձեր բջջայինում Facebook-ը, Instagram-ը կամ եղանակային հավելվածը տեսնելու համար, դուք օգտագործում եք API-ն: Նմանապես, եթե դուք օգտագործում եք LabCollector LIMS-ը և ցանկանում եք միանալ երրորդ կողմի ծրագրակազմին, կարող եք միանալ API-ի միջոցով:
The LabCollector Web Service Application Programming Interface (API) թույլ է տալիս երրորդ կողմի հավելվածներին փոխազդել երկուսի հետ LabCollector-ի տվյալների բազան (մոդուլները) և LabCollector հավելումներ (ELN և LSM):
AgileBio-ն առաջարկում է API (դրանք բացատրվում են ստորև բերված բաժիններում).-
- Հիմնական LC APIՕգտագործելով սա դուք կարող եք աշխատել/արդյունահանել մոդուլների տվյալները (նմուշներ..), պահեստավորում, ֆայլեր ստանալ/տեղադրել…
- ELN APIՍա օգնում է ձեզ աշխատել գրքերի/էջերի վրա (ստանալ/ավելացնել), վերբեռնել ֆայլեր/պատկերներ
- LSM APIՍրանով դուք կարող եք աշխատել վերլուծական/ծառայությունների վրա (ավելացնել աշխատատեղեր, թարմացնել արդյունքները, ստանալ արդյունքներ…)
- WF API (New!Սա կարող է օգնել գործարկել նոր աշխատանքային հոսքեր, փոխել կարգավիճակը
API-ն հիմնված է ներկայացուցչական պետական փոխանցման (REST) ճարտարապետության վրա, որը թույլ է տալիս մուտք գործել դեպի ռեսուրսներ Uniform Resource Identifier (URI) և դրանց վերաբերյալ գործողությունների միջոցով:
API-ն նաև ապահովում է անվտանգություն տվյալների ամբողջականության առումով: Օրինակ, երբ երկու հավելվածներ խոսում են API-ի հետ, նրանք խոսում են միայն տվյալների փոքր փաթեթների մասին, որոնք անհրաժեշտ են: Օրինակ, երբ դուք ապրանք եք պատվիրում amazon-ից: Դուք պարզապես փոխանցում եք ձեր ուզած իրերը, այնուհետև դրանք առաքվում են ձեզ: Դուք չեք հանդիպում ապրանքների արտադրության կամ փաթեթավորման կամ տեղափոխման ամբողջ գործընթացին և այլն: Նույն տվյալները LabCollector տեսանելի է միայն որոշ մասերում (ռեսուրսներ), որոնք կարող են փոփոխվել API-ի օգնությամբ:
Հետևեք այս քայլերին կարգավորելու համար LabCollector API: -
1. API-ի ընդհանուր կարգավորում
2. Ինչպես օգտվել API-ից
3. API-ի համար LabCollectorՄիասնական ռեսուրսի նույնացուցիչ (URI)
4. API-ի օրինակներ
5. LSM API
6. ELN API
7. Workflow API * ՆՈՐ
8. Անսարքությունների վերացում (սխալի հաղորդագրություններ)
9. Հավելված-Վեբ ծառայության API
1. API-ի ընդհանուր կարգավորում
- API-ն կարգավորելու համար LabCollector դուք պետք է հայտարարեք ձեր դիմումը LabCollector.
- Դա անելու համար խնդրում ենք մուտք գործել LabCollector որպես սուպերադմին.
* Խնդրում ենք կարդալ մեր KB տեսնելու համար ինչում են սուպերադմինիստրատորի թույլտվությունները LabCollector. - Է LabCollector երբ մուտք եք գործում, գնացեք ADMIN -> ԿԱՐԳԱՎԻԱԿ -> WEB SERVICES API
- Դուք կտեսնեք ստորև բերված էջը, որտեղ կարող եք սահմանել նոր հավելված, որին ցանկանում եք միանալ LabCollector API-ի միջոցով:
- 1. ԱՆՈՒՆ Այստեղ կարող եք ավելացնել ձեր դիմումի անվանումը: Օրինակ՝ նպատակի համար մենք ավելացրել ենք մեր հավելման անունը, որը նմուշի ընդունում է:
- 2. ԼԱՆԿԱԴՐՎԱԾ ՕՊԵՐԱՏՈՐ. Այստեղ կարող եք մուտքագրել այն անձին, ում ցանկանում եք լինել այս API-ի օպերատորը: Եթե դուք չեք ավելացնում օպերատորին այստեղ, ապա դուք պետք է այն ավելացնեք API-ի միջոցով կատարվող յուրաքանչյուր հարցման ժամանակ:
- 3. IP ՍԱՀՄԱՆԱՓԱԿՈՒՄ: Այս ընտրանքը թույլ է տալիս ձեզ անվտանգության շերտ, քանի որ այստեղ կարող եք սահմանել, թե որ IP (ինտերնետ պրոտոկոլ) հասցեներն են թույլատրվում աշխատել ձեր սահմանած API-ի վրա: Հիշեք, որ եթե ընտրեք «այո», ապա IP հասցե մուտքագրելու տուփը կհայտնվի միայն ձեր կարգավորումը պահպանելուց հետո:
- 4. ԱՅՍ ՀԻՄՆԱԿԱՆ ՀԵՏ ԿԱՊՎԱԾ ՄՈԴՈՒԼՆԵՐ. Կան 12 լռելյայն մոդուլներ ներկա LabCollector. Բացի դրանից, դուք կարող եք նաև ստեղծել նոր մաքսային հավելումներ՝ ըստ ձեր պահանջների: Բոլոր լռելյայն և մաքսային մոդուլները և հավելումները ներկա կլինեն այստեղ, և դուք կարող եք ընտրել, թե որ մոդուլներն եք ցանկանում փոխազդել API-ի հետ:
- 5. ԱՆՎԱՐ: Ձեր կարգավորումները սահմանելուց հետո կարող եք սեղմել ավելացնել և ձեր API-ն ստորև տեսք կունենա:
- A. Այժմ կարող եք ավելացնել IP հասցեն և սեղմել «Ավելացնել նոր IP»:
- B. Սեղմելով թարմացման պատկերակը, կարող եք խմբագրել ձեր API կարգավորումները:
- C. Սա ձեր նշանային համարն է, որը կարող է օգտագործվել API-ին միանալու համար: Դուք նույնիսկ կարող եք դրա համար ստեղծել շտրիխ կոդ և պատճենել այն՝ սեղմելով դրա վրա icon.
2. Ինչպես օգտվել API-ից
- Հեռավոր (երրորդ կողմի) հավելվածների միջև հաղորդակցման երկխոսությունը և LabCollector հիմնված է HTTP 1.1 արձանագրության վրա: (*Ստուգելու համար, թե ինչ ռեսուրս է, տես վերևի նկարը)
- Դուք կարող եք փոփոխել, կարդալ, ստեղծել կամ ջնջել ռեսուրս՝ օգտագործելով GET, POST, PUT և DELETE: մեթոդ ինչպես ցույց է տրված վերևի նկարում:
- Դուք կարող եք փոփոխություն պահանջել, այնուհետև ստանալ փոփոխության պատասխանը, ինչպես բացատրված է ստորև:
- Օրինակ՝ նպատակի համար մենք օգտագործել ենք POSTMAN հավելված Գործիք API-ի համար և ինտերֆեյսը կարծես ստորև է:
- Ինչպես տեսնում եք վերը նշված նկարում, կարող եք մուտքագրել API URL-ը (օրինակ՝ հղում դեպի LabCollector's Strains & Cells մոդուլը) և փոփոխություններն ավարտելուց և ուղարկել ուղարկելուց հետո կստանաք պատասխան:
Եթե ամեն ինչ ճիշտ է, և հարցումը կատարվել է, ապա պատասխանը կստանա ստորև՝ Փոստատարի հավելվածում:
- 1. Այստեղ դուք կարող եք ընտրել ձեր հարցման մեթոդը: (ՍՏԱՆԱԼ, ՓԱԿՑՐԵԼ, ԴՐԵԼ և Ջնջել)
- 2. API-ին ուղղված հարցումը պահանջում է որոշակի HTTP/HTTPS վերնագրեր
- 3. The Ընդունել վերնագիրը սահմանում է ձեր հարցման պատասխանի ցանկալի ձևաչափը՝ տեքստ/XML (կանխադրված) կամ հավելված/JSON:
- 4. The X-LC-APP-Auth վերնագիր, որտեղ դուք դնում եք ձեր դիմումի նշանը, որն անհրաժեշտ է ձեր հարցումը API-ին լիազորելու համար:
- 5. The X-LC-APP-Charset վերնագիրը սահմանում է ձեր հավելվածի նիշերի կոդավորումը: Այն թույլ է տալիս API-ին հետ ուղարկել պատասխանը համապատասխան կոդավորումով և ճիշտ վերափոխել ձեր POST և PUT հարցումները LabCollector-ի նիշերի կոդավորումը (ISO 8859-1):
3. API-ի համար LabCollector: Միատեսակ ռեսուրսի նույնացուցիչ (URI)
- Միասնական ռեսուրսի նույնացուցիչը (URI) նիշերի շարան է, որը միանշանակորեն նույնացնում է որոշակի ռեսուրսը:
-
URL-ի վերագրանցումը միացված է (mod_rewrite)
Նշում: Դուք պետք է դա անեք ձեր apache ֆայլում:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]
-
Սովորական URL-ներ.
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD]
- URI-ի և այն օգտագործելու մասին ավելին իմանալու համար LabCollector, խնդրում եմ կարդալ մեր ձեռնարկը LabCollector API էջ 7-17։
4. API-ի օրինակներ
- Կոդերի օրինակներ C#
string url = _Url.Replace("{id}", txtDataID.Text); var client = նոր RestSharp.RestClient(url); հաճախորդ. Timeout = 900000; var հարցում = նոր RestSharp.RestRequest(); խնդրանք: Ժամկետը = 900000; request.Method = Method.GET; request.AddHeader («X-LC-APP-Auth», նշան); request.AddHeader ("Ընդունել", "տեքստ/xml"); /////////////////// IRestResponse պատասխան = հաճախորդ. Կատարել (հարցում); լարային արդյունք = պատասխան.Բովանդակություն;
- Կոդերի օրինակներ PHP:
API-ից HEADER ՏԵՂԵԿՈՒԹՅՈՒՆՆԵՐ ՍՏԱՆԱԼ $API_response = curl_exec($curl); curl_close ($ curl); echo $API_response; ?>
- Օրինակ, API դեպի ուղարկել ֆայլ:
labcollector.rar'; $file_info = getimagesize ($file_path); $ file_size = ֆայլի չափ ($ file_path); $update = զանգված ( '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, զանգված ('X-LC-APP-Auth: TOKEN', 'Content-Type'.$file_info['mime']) curl_setopt($curl, CURLOPT_URL, $curl_setopt($curl, CURLOPT_RETURNTRANSFER, true ($curl, CURLOST)); ; LOPT_HEADER , true //OPTIONAL -> ՍՏԱՆԱԼԵԼ HEADER INFO FROM THE API_response = curl_exec($curl_close($curl);
5. LSM API
- Lab Service Manager-ը (LSM) մեր հավելումն է սպասարկման հիմնական/փորձարկման լաբորատորիաների համար:
- Ինչպես բացատրվեց նախկինում, կարող եք կարգավորել LSM հավելմանը միանալու համար (նշելով հավելումների դիմացի վանդակը), ինչպես ցույց է տրված բաժին 1 վերեւում:
- Դուք կարող եք օգտագործել API-ն՝ օգտագործելու GET մեթոդը՝ կարդալու/առբերելու տարբեր պարամետրերի մասին տեղեկությունները, որոնք դուք օգտագործում եք թեստում, օրինակ՝ նմուշի անվանումը, փորձարկման կարգավիճակը, խմբաքանակի տեղեկատվությունը, աշխատանքի id-ն և այլն,
- Խնդրում ենք մեր KB LSM API-ի վրա:
- LSM API-ի մասին ավելին իմանալու և այն օգտագործելու համար LabCollector, խնդրում եմ կարդացեք մեր ձեռնարկը API-ի վերաբերյալ էջ 18-28։
6. ELN API
- Էլեկտրոնային լաբորատոր նոթատետր (ELN) հավելումը թղթե լաբորատոր նոթատետրի փոխարինումն է։
- Ինչպես բացատրվեց նախկինում, կարող եք կարգավորել միանալու համար ELN հավելում (ստուգելով հավելումների դիմացի վանդակը, ինչպես ցույց է տրված բաժին 1 վերեւում:
- Դուք կարող եք օգտագործել API-ն՝ օգտագործելու GET և POST մեթոդը՝ գրքերի, փորձերի և էջերի տվյալների մասին տեղեկություններ կարդալու/առբերելու համար:
- Խնդրում ենք մեր ԿԲ միացված է ELN API:
- Իմանալ ավելին ELN API և ինչպես օգտագործել այն LabCollector, խնդրում եմ կարդալ մեր ձեռնարկը ELN API էջ 29-30։
7. Workflow API * ՆՈՐ
- Աշխատանքային հոսքի հավելումը կարող է օգտագործվել այն ինստիտուտների կողմից, ովքեր ցանկանում են հետևել խիստ քայլ առ քայլ վավերացման արձանագրությանը:
- LabCollector այժմ առաջարկում է միանալ աշխատանքային հոսքի հավելմանը API-ի օգնությամբ:
- Workflow API-ի օգնությամբ այժմ կարող եք կատարել տվյալ աշխատանք կամ լրացնել հանգույցը: (հանգույցը աշխատանքային հոսքի հավելման գործընթաց կամ քայլ է)
- Աշխատանքային հոսքի API-ի և այն օգտագործելու մասին ավելին իմանալու համար LabCollector, խնդրում եմ կարդացեք մեր ձեռնարկը Workflow API-ի վերաբերյալ.
8. Անսարքությունների վերացում (սխալի հաղորդագրություններ)
- API գործառույթներն իրականացնելիս կարող են սխալներ հանդիպել:
- Դուք կարող եք վերացնել այս սխալները մեր օգնությամբ KB API-ի սխալ հաղորդագրությունների վրա:
- LSM API-ի մասին ավելին իմանալու և այն օգտագործելու համար LabCollector, խնդրում եմ կարդացեք մեր ձեռնարկը LSM API-ի վերաբերյալ.
9. Հավելված-Վեբ ծառայության API
- Հավելվածը նկարագրում է մաքուր URL-ները, որոնք պետք է օգտագործվեն ճիշտ գործելու համար:
- Հավելվածը նկարագրում է բոլոր URI-ները, որոնք պետք է օգտագործվեն համապատասխան մոդուլի և նկարագրության հետ, ինչպես նաև տեղեկացնում է ձեզ մեթոդի մասին (PUT, POST և այլն), որը պետք է օգտագործվի դրա համար:
- Դուք պետք է միացնեք apache շարժիչը հավելվածում նկարագրված URI-ն օգտագործելու համար: Կարդացեք կամ միացրեք KB վեբ ծառայության/apache կարգավորում:
- LSM API-ի մասին ավելին իմանալու և այն օգտագործելու համար LabCollector, խնդրում եմ կարդացեք մեր ձեռնարկը API-ի վերաբերյալ էջ 33-37։
Առնչվող թեմաներ.
- Կարդացեք մեր ձեռնարկը միացված է LabCollector.
- Կարդացեք մեր ձեռնարկ API-ի վրա.
- Ստուգեք մեր KB LSM API-ի վրա:
- Ստուգեք մեր ԿԲ միացված է ELN API:
- Կարդացեք մեր KB Workflow API-ում:
- Կարդացեք մեր ԿԲ-ն վեբ ծառայության/apache կարգավորում:
- Կարդացեք մեր ԿԲ-ն API-ի սխալ հաղորդագրություններ.
- Ստուգում ինչպես ստեղծել պահեստավորման տուփեր/ափսեներ API-ով: