2. نحوه استفاده از API 

• گفتگوی ارتباطی بین برنامه های کاربردی از راه دور (شخص ثالث) و LabCollector بر اساس پروتکل HTTP 1.1 است. (* برای بررسی اینکه چه منبعی است به تصویر بالا مراجعه کنید)

  

• می توانید با استفاده از GET، POST، PUT و DELETE یک منبع را تغییر دهید، بخوانید، ایجاد یا حذف کنید. روش همانطور که در تصویر بالا نشان داده شده است.
• شما می توانید درخواست تغییر دهید و سپس پاسخ اصلاح را همانطور که در زیر توضیح داده شده است دریافت کنید.
• به عنوان مثال هدف، ما از برنامه POSTMAN ابزار برای API و رابط مانند زیر است.
  

• همانطور که در تصویر بالا می بینید، می توانید URL API را تایپ کنید (به عنوان مثال پیوند به LabCollectorماژول Strains & Cells) و پس از اتمام تغییرات و زدن send، پاسخی دریافت خواهید کرد.
  اگر همه چیز درست باشد و درخواست انجام شده باشد، پاسخ به شکل زیر در برنامه Postman خواهد بود.
  
• 1. در اینجا می توانید روش درخواست خود را انتخاب کنید. (دریافت، پست، قرار دادن و حذف)
• 2. درخواست به API به HTTP/HTTPS خاصی نیاز دارد سرصفحه ها
• 3. La پذیرفتن هدر فرمت پاسخ مورد نظر درخواست شما، متن/XML (پیش‌فرض)، یا برنامه/JSON را مشخص می‌کند.
• 4. La X-LC-APP-Auth هدر جایی که توکن برنامه خود را که برای تأیید درخواست شما به API ضروری است، قرار می دهید.
• 5. La X-LC-APP-Charset هدر رمزگذاری کاراکتر برنامه شما را مشخص می کند. این به API اجازه می دهد تا پاسخ را با رمزگذاری مناسب ارسال کند و درخواست های POST و PUT شما را به درستی به LabCollectorرمزگذاری کاراکتر (ISO 8859-1).

3. API برای LabCollector: شناسه منبع یکنواخت (URI)

• یک شناسه منبع یکنواخت (URI) رشته ای از کاراکترها است که به طور واضح یک منبع خاص را شناسایی می کند.

• URL بازنویسی روشن (mod_rewrite در)
  توجه داشته باشید: شما باید این کار را در فایل آپاچی خود انجام دهید.
  

  [مسیری به_LABCOLLECTOR]/webservice/v2/[MODULE]

• URL های معمولی:

  [مسیری به_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) جدید؛ client.Timeout = 900000; var request = new RestSharp.RestRequest(); درخواست.تایم اوت = 900000; request.Method = Method.GET; request.AddHeader("X-LC-APP-Auth"، نشانه); request.AddHeader("Accept", "text/xml"); //////////////////// پاسخ IRestResponse = client.Execute(درخواست); نتیجه رشته = پاسخ. محتوا;

• نمونه ای از کدهای موجود در پی اچ پی:

  برای دریافت اطلاعات هدر از API $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>

• به عنوان مثال از API به یک فایل ارسال کنید:

  labcollector.rar'; $file_info = getimagesize($file_path); $file_size = حجم فایل ($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'])); ; LOPT_HEADER , true //OPTIONAL -> TO RECEIVE HEADER INFO FROM THE API $API_response = curl_exec($curl_close($curl);

5. LSM API

• مدیر خدمات آزمایشگاهی (LSM) افزونه ما برای آزمایشگاه‌های اصلی/آزمایشگاهی خدمات است.
• همانطور که قبلا توضیح داده شد، می‌توانید پیکربندی اتصال به افزونه LSM را انجام دهید (با علامت زدن کادر جلوی افزونه‌ها) همانطور که در نشان داده شده است. بخش 1 در بالا.
• می‌توانید از API برای استفاده از روش GET برای خواندن/بازیابی اطلاعات در مورد پارامترهای مختلفی که در آزمایش استفاده می‌کنید مانند نام نمونه، وضعیت سنجش، اطلاعات دسته، شناسه کار و غیره استفاده کنید.
• لطفا ما KB در LSM API.
• برای آشنایی بیشتر با LSM API و نحوه استفاده از آن LabCollector، لطفا راهنمای ما در API را بخوانید صفحه 18-28.

6. ELN API

• دفترچه یادداشت آزمایشگاه الکترونیک (ELN) افزودنی جایگزینی دفترچه یادداشت آزمایشگاهی کاغذی است. 
• همانطور که قبلا توضیح داده شد می توانید پیکربندی برای اتصال به ELN افزونه (با علامت زدن کادر روبروی افزونه ها همانطور که در شکل نشان داده شده است بخش 1 در بالا.
• می‌توانید از API برای استفاده از روش GET و POST برای خواندن/بازیابی اطلاعات مربوط به کتاب‌ها، آزمایش‌ها و صفحات استفاده کنید.
• لطفا ما KB روشن است ELN API
• برای دانستن بیشتر در مورد ELN API و نحوه استفاده از آن LabCollector، لطفا کتابچه راهنمای ما را بخوانید ELN API صفحه 29-30.

7. API گردش کار *جدید

• افزونه گردش کار می تواند توسط مؤسساتی که می خواهند از پروتکل اعتبارسنجی گام به گام دقیق پیروی کنند، استفاده شود.
• LabCollector اکنون اتصال به افزونه گردش کار را با کمک API ارائه می دهد.
• با کمک API گردش کار، اکنون می توانید یک کار داده شده را اجرا کنید یا یک گره را تکمیل کنید. (گره یک فرآیند یا مرحله در افزونه گردش کار است)
• برای آشنایی بیشتر با API گردش کار و نحوه استفاده از آن LabCollector، لطفا راهنمای ما در مورد Workflow API را بخوانید.

8. عیب یابی (پیام های خطا)

• ممکن است هنگام اجرای توابع API با خطا مواجه شود.
• شما می توانید این خطاها را با کمک ما عیب یابی کنید KB در پیام های خطای API.
• برای آشنایی بیشتر با LSM API و نحوه استفاده از آن LabCollector، لطفا راهنمای ما در مورد LSM API را بخوانید.

9. Annex-Web Service API

• ضمیمه URL های تمیزی را که باید برای عملکرد صحیح استفاده شوند، توضیح می دهد.
• ضمیمه تمام URI هایی را که باید با ماژول و توضیحات مربوطه استفاده شود، توضیح می دهد و همچنین شما را در مورد روشی (PUT، POST و غیره) که برای آن استفاده می شود، آگاه می کند.
• شما باید موتور آپاچی را فعال کنید تا از URI توضیح داده شده در ضمیمه استفاده کند. خواندن یا KB روشن راه اندازی وب سرویس/آپاچی
• برای آشنایی بیشتر با LSM API و نحوه استفاده از آن LabCollector، لطفا راهنمای ما در API را بخوانید صفحه 33-37.

مطالب مرتبط:

• خوانده شده ما دفترچه راهنمای روشن LabCollector.
• خوانده شده ما کتابچه راهنمای API.
• بررسی ما KB در LSM API.
• بررسی ما KB روشن است ELN API
• خوانده شده ما KB در Workflow API.
• KB ما را در راه اندازی وب سرویس/آپاچی
• KB ما را در پیام های خطای API
• بررسی نحوه ایجاد جعبه/صفحات ذخیره سازی با API.