Giới thiệu về LabCollector API- LabCollector

Tìm kiếm cơ sở kiến ​​thức theo từ khóa

Bạn đang ở đây:
← Tất cả các chủ đề
TỔNG KẾT:

API là Giao diện lập trình ứng dụng, giao diện điện toán xác định sự tương tác giữa nhiều phần mềm trung gian. Nói một cách đơn giản, nó cho phép hai ứng dụng nói chuyện với nhau. Ví dụ: khi bạn sử dụng bất kỳ ứng dụng nào trên điện thoại di động của mình để xem Facebook, Instagram hoặc ứng dụng thời tiết, bạn đang sử dụng API. Tương tự, nếu bạn đang sử dụng LabCollector LIMS và bạn muốn kết nối với phần mềm của bên thứ ba, bạn có thể kết nối qua API.

Sản phẩm LabCollector Giao diện lập trình ứng dụng dịch vụ web (API) cho phép các ứng dụng của bên thứ ba tương tác với cả hai LabCollectorcơ sở dữ liệu của (mô-đun) và LabCollector tiện ích bổ sung (ELN và LSM).

AgileBio cung cấp API cho (chúng được giải thích trong các phần bên dưới): -

  • API LC chính: Sử dụng tính năng này, bạn có thể làm việc/trích xuất dữ liệu mô-đun (mẫu..), lưu trữ, lấy/đặt tệp…
  • ELN API: Điều này giúp bạn làm việc trên sách/trang (lấy/thêm), tải lên tệp/hình ảnh
  • API LSM: Với điều này, bạn có thể làm việc về phân tích / dịch vụ (thêm công việc, cập nhật kết quả, nhận kết quả…)
  • API WF (Mới!): Điều này có thể giúp kích hoạt quy trình làm việc mới, thay đổi trạng thái

API dựa trên kiến ​​trúc Chuyển trạng thái đại diện (REST) ​​cho phép truy cập vào tài nguyên thông qua Mã định danh tài nguyên thống nhất (URI) và các hành động trên chúng. 

API cũng cung cấp bảo mật về tính toàn vẹn dữ liệu. Ví dụ: khi hai ứng dụng đang nói chuyện với API, chúng chỉ nói về những gói dữ liệu nhỏ cần thiết. Ví dụ: khi bạn đặt mua một mặt hàng từ amazon. Bạn chỉ cần chuyển tải những mặt hàng bạn muốn và sau đó chúng sẽ được giao cho bạn. Bạn không xem toàn bộ quá trình sản xuất, đóng gói hoặc vận chuyển mặt hàng, v.v. Dữ liệu tương tự trong LabCollector chỉ hiển thị ở một số phần (tài nguyên) có thể được sửa đổi với sự trợ giúp của API.

Làm theo các bước sau để định cấu hình LabCollector API: -

1. Thiết lập chung API

2. Cách sử dụng API 

3. API cho LabCollector: Mã định danh tài nguyên thống nhất (URI)

4. Ví dụ về API

5. API LSM

6. ELN API

7. API quy trình làm việc *MỚI

8. Khắc phục sự cố (thông báo lỗi)

9. API dịch vụ Web phụ lục

1. Thiết lập chung API

  • Để định cấu hình API trong LabCollector bạn phải khai báo đơn đăng ký của mình trong LabCollector.
  • Để làm như vậy xin vui lòng đăng nhập vào LabCollector như là một Quản trị viên cấp cao. 
    * Hãy đọc KB của chúng tôi để xem quyền quản trị viên cấp cao là gì LabCollector.
  • Trong tạp chí LabCollector khi bạn đăng nhập, hãy truy cập QUẢN TRỊ VIÊN -> THIẾT LẬP -> API DỊCH VỤ WEB

  • Bạn sẽ thấy trang bên dưới nơi bạn có thể xác định ứng dụng mới mà bạn muốn kết nối LabCollector thông qua API.

 

  • 1. TÊN: Tại đây bạn có thể thêm tên ứng dụng của mình. Ví dụ: mục đích, chúng tôi đã thêm tên của tiện ích bổ sung của chúng tôi để nhận mẫu.
  • 2. NGƯỜI ĐIỀU HÀNH MẶC ĐỊNH: Tại đây bạn có thể nhập người mà bạn muốn trở thành người điều hành API này. Nếu không thêm toán tử ở đây thì bạn sẽ phải thêm toán tử đó trong mỗi yêu cầu mà bạn thực hiện thông qua API.
  • 3. HẠN CHẾ IP: Tùy chọn này cho phép bạn một lớp bảo mật vì bạn có thể xác định ở đây địa chỉ IP (giao thức internet) nào được phép hoạt động trên API mà bạn đang xác định. Hãy nhớ rằng nếu bạn chọn “có” thì hộp nhập địa chỉ IP sẽ chỉ xuất hiện sau khi bạn lưu cài đặt của mình.
  • 4. MODULE KẾT NỐI VỚI ỨNG DỤNG NÀY: Có 12 mô-đun mặc định có trong LabCollector. Ngoài ra, bạn cũng có thể tạo các tiện ích bổ sung tùy chỉnh mới theo yêu cầu của mình. Tất cả các mô-đun mặc định và tùy chỉnh cũng như các tiện ích bổ sung sẽ có mặt ở đây và bạn có thể chọn mô-đun nào bạn muốn tương tác với API.
  • 5. THÊM VÀO: khi bạn đã xác định cài đặt của mình, bạn có thể nhấp vào thêm và API của bạn sẽ trông như bên dưới.
  • A. Bây giờ bạn có thể thêm địa chỉ IP và nhấp vào “Thêm IP mới”.
  • B. Bằng cách nhấp vào biểu tượng cập nhật, bạn có thể chỉnh sửa cài đặt API của mình.
  • C. Đây là số mã thông báo của bạn có thể được sử dụng để kết nối với API. Bạn thậm chí có thể tạo mã vạch cho nó và sao chép nó bằng cách nhấp vào biểu tượng.
 LƯU Ý: Lưu ý: Để sử dụng tính năng này, bạn cần kích hoạt Curl trên tùy chọn PHP của mình. Trong Linux, cài đặt gói PHP-Curl. Trên windows và với trình cài đặt tự động của chúng tôi, hãy chỉnh sửa PHP.ini và các tiện ích mở rộng không ghi chú cho Curl (extension=php_curl.dll).

2. Cách sử dụng API 

  • Cuộc đối thoại giao tiếp giữa các ứng dụng từ xa (bên thứ ba) và LabCollector dựa trên giao thức HTTP 1.1. (* Để kiểm tra tài nguyên là gì, xem hình trên)

  • Bạn có thể sửa đổi, đọc, tạo hoặc xóa tài nguyên bằng cách sử dụng GET, POST, PUT và DELETE phương pháp như thể hiện trong hình ảnh trên.
  • Bạn có thể yêu cầu sửa đổi và sau đó nhận được phản hồi về việc sửa đổi như được giải thích bên dưới.
  • Ví dụ mục đích, chúng tôi đã sử dụng ứng dụng POSTMAN Công cụ cho API và giao diện như bên dưới.

  • Như bạn có thể thấy trong hình trên, bạn có thể nhập URL API (ví dụ: liên kết tới LabCollector's Strains & Cells module) và sau khi hoàn thành việc sửa đổi và nhấn gửi, bạn sẽ nhận được phản hồi.
    Nếu mọi thứ đều chính xác và yêu cầu đã được thực hiện thì phản hồi sẽ như bên dưới trong ứng dụng Người đưa thư.
  • 1. Tại đây bạn có thể chọn phương thức yêu cầu của mình. (NHẬN, ĐĂNG, ĐẶT và XÓA)
  • 2. Yêu cầu tới API yêu cầu một số HTTP/HTTPS cụ thể tiêu đề.
  • 3. Sản phẩm Chấp nhận tiêu đề xác định định dạng phản hồi mong muốn của yêu cầu, văn bản/XML (mặc định) hoặc ứng dụng/JSON của bạn.
  • 4. Sản phẩm X-LC-APP-Auth tiêu đề nơi bạn đặt mã thông báo ứng dụng cần thiết để ủy quyền yêu cầu của bạn tới API.
  • 5. Sản phẩm X-LC-APP-Bộ ký tự tiêu đề xác định mã hóa ký tự của ứng dụng của bạn. Nó cho phép API gửi lại phản hồi với mã hóa thích hợp và chuyển đổi chính xác các yêu cầu POST và PUT của bạn thành LabCollectormã hóa ký tự của (ISO 8859-1).

3. API cho LabCollector: Mã định danh tài nguyên đồng nhất (URI)

  • Mã định danh tài nguyên thống nhất (URI) là một chuỗi ký tự xác định rõ ràng một tài nguyên cụ thể.

  • URL viết lại BẬT (mod_rewrite)
    Lưu ý: Bạn phải thực hiện việc này trong tệp Apache của mình.

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MÔ-ĐUN]

  • URL thông thường:

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD]
  • Để biết thêm về URI và cách sử dụng nó với LabCollector, Xin vui lòng đọc hướng dẫn của chúng tôi trên LabCollector API trang 7-17.

4. Ví dụ về API

  • Ví dụ về mã trong C# 
    chuỗi url = _Url.Replace("{id}", txtDataID.Text); var client = new RestSharp.RestClient(url); client.Timeout = 900000; var request = new RestSharp.RestRequest(); yêu cầu.Timeout = 900000; request.Method = Method.GET; request.AddHeader("X-LC-APP-Auth", mã thông báo); request.AddHeader("Chấp nhận", "text/xml"); //////////////////// Phản hồi IrestResponse = client.Execute(request); kết quả chuỗi = phản hồi.Content;
  • Ví dụ về mã trong PHP: 
    ĐỂ NHẬN THÔNG TIN TIÊU ĐỀ TỪ API $API_response =curl_exec($curl); Curl_close($curl); echo $API_response; ?>
  • Ví dụ về API đến gửi một tập tin: 
    labcollector.rar'; $file_info = getimagesize($file_path); $file_size = kích thước file($file_path); $update = array( 'health_report_file[0]' => '@'.$file_path.";filename=zz_labcollector.rar;type=application/x-rar-compression", 'health_report_file[1]' => '@'.$file_path2.";filename=zz_labcollector2.rar;type=application/x-rar-compression", 'upload_mode' => 'add' ); $curl =curl_init();curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-LC-APP-Auth: TOKEN', 'Loại nội dung: '.$file_info['mime']));curl_setopt($curl, CURLOPT_URL, $url);curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); ;curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");curl_setopt($curl, CURLOPT_POSTFIELDS, $update);curl_setopt($curl, CURLOPT_CONNECTTIMEOUT,0); , true); // TÙY CHỌN -> ĐỂ NHẬN THÔNG TIN TIÊU ĐỀ TỪ API $API_response =curl_exec($curl);

5. API LSM

  • Lab Service Manager (LSM) là tiện ích bổ sung của chúng tôi dành cho các phòng thí nghiệm thử nghiệm/cốt lõi dịch vụ.
  • Như đã giải thích trước khi bạn có thể định cấu hình để kết nối với tiện ích bổ sung LSM (bằng cách chọn hộp phía trước tiện ích bổ sung) như minh họa trong phần 1 ở trên.
  • Bạn có thể sử dụng API để sử dụng phương thức GET để đọc/truy xuất thông tin về các thông số khác nhau mà bạn sử dụng trong thử nghiệm như tên mẫu, trạng thái xét nghiệm, thông tin lô, id công việc, v.v.
  • Xin vui lòng của chúng tôi KB trên API LSM.
  • Để biết thêm về API LSM và cách sử dụng nó với LabCollector, Xin vui lòng đọc hướng dẫn của chúng tôi về API trang 18-28.

6. ELN API

  • Sổ tay phòng thí nghiệm điện tử (ELN) tiện ích bổ sung là sự thay thế của sổ ghi chép trong phòng thí nghiệm bằng giấy. 
  • Như đã giải thích trước khi bạn có thể cấu hình để kết nối với ELN tiện ích bổ sung (bằng cách đánh dấu vào ô phía trước các tiện ích bổ sung như minh họa trong phần 1 ở trên.
  • Bạn có thể sử dụng API để sử dụng phương thức GET và POST để đọc/truy xuất thông tin về dữ liệu của sách, thí nghiệm và trang.
  • Xin vui lòng của chúng tôi KB bật ELN API.
  • Để biết thêm về ELN API và cách sử dụng nó với LabCollector, Xin vui lòng đọc hướng dẫn của chúng tôi trên ELN API trang 29-30.

7. API quy trình công việc *MỚI

  • Tiện ích bổ sung quy trình làm việc có thể được sử dụng bởi các tổ chức muốn tuân theo quy trình xác thực từng bước nghiêm ngặt.
  • LabCollector hiện cung cấp khả năng kết nối với tiện ích bổ sung quy trình làm việc với sự trợ giúp của API.
  • Với sự trợ giúp của API quy trình công việc, giờ đây bạn có thể thực hiện một công việc nhất định hoặc hoàn thành một nút. (nút là một quy trình hoặc bước trong tiện ích bổ sung quy trình làm việc)
  • Để biết thêm về API quy trình công việc và cách sử dụng nó với LabCollector, Xin vui lòng đọc hướng dẫn của chúng tôi về API quy trình làm việc.

8. Khắc phục sự cố (thông báo lỗi)

9. API dịch vụ web phụ lục

  • Phụ lục mô tả các URL sạch sẽ được sử dụng để hoạt động bình thường.
  • Phụ lục mô tả tất cả các URI sẽ được sử dụng với mô-đun và mô tả liên quan, đồng thời thông báo cho bạn về phương thức (PUT, POST, v.v.) sẽ được sử dụng cho cùng một phương thức.
  • Bạn cần kích hoạt công cụ apache để sử dụng URI được mô tả trong Phụ lục. Đọc hoặc bật KB thiết lập dịch vụ web/apache.
  • Để biết thêm về API LSM và cách sử dụng nó với LabCollector, Xin vui lòng đọc hướng dẫn của chúng tôi về API trang 33-37.

Chủ đề liên quan: