简介 LabCollector API - LabCollector

通过关键字搜索知识库

你在这里：
←所有主题
概要：

API 是应用程序编程接口，一种定义多个软件中介之间交互的计算接口。简而言之，它允许两个应用程序相互通信。例如，当您使用移动设备上的任何应用程序查看 Facebook、Instagram 或天气应用程序时，您正在使用 API。同样，如果您正在使用 LabCollector LIMS想要和第三方软件连接，可以通过API连接。

LabCollector Web 服务应用程序编程接口 (API) 允许第三方应用程序与两者进行交互 LabCollector的数据库（模块）和 LabCollector 附加组件（ELN 和 LSM）。

AgileBio 提供 API 用于（它们将在下面的部分中解释）：-

  • 主要 LC API：使用它，您可以工作/提取模块数据（样本..）、存储、获取/放置文件......
  • ELN API：这可以帮助您处理书籍/页面（获取/添加）、上传文件/图像
  • LSM API：有了这个，您可以从事分析/服务（添加职位、更新结果、获取结果......）
  • WF API (新品种！)：这可以帮助触发新的工作流程、更改状态

该 API 基于表述性状态传输 (REST) 架构，允许访问 资源 通过统一资源标识符 (URI) 及其上的操作。 

API 还提供数据完整性方面的安全性。例如，当两个应用程序与 API 进行通信时，它们仅以必要的小数据包进行通信。例如，当您从亚马逊订购商品时。您只需传达您想要的物品，然后它们就会交付给您。您不会遇到物品制造、包装或运输等的整个过程。相同的数据 LabCollector 仅在某些可以借助 API 进行修改的部分（资源）中可见。

按照以下步骤配置 LabCollector 应用程序编程接口：-

1. API通用设置

2. API使用方法 

3.API用于 LabCollector：统一资源标识符（URI）

4. API示例

5. LSM API

6. ELN API

7. 工作流程API *新

8. 故障排除（错误消息）

9. 附件-Web服务API

1. API 一般设置

  • 配置API LabCollector 您必须在以下位置申报您的申请 LabCollector.
  • 为此，请登录 LabCollector 作为一个 超级管理员。 
    * 请阅读我们的知识库以了解 超级管理员权限是什么 LabCollector.
  • 在 LabCollector 当您登录时转到 ADMIN -> 设置 -> 网络服务 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。您甚至可以为其创建条形码并通过单击复制它 图标。
 注意: 注意：要使用此功能，您需要在 PHP 首选项中激活 Curl。在 Linux 中，安装 PHP-Curl 包。在 Windows 上，使用我们的自动安装程序，编辑 PHP.ini 并取消注释 Curl 扩展名 (extension=php_curl.dll)。

2. 如何使用API 

  • 远程（第三方）应用程序和 LabCollector 基于HTTP 1.1协议。 （*要检查什么是资源，请参见上图）

  • 您可以使用 GET、POST、PUT 和 DELETE 修改、读取、创建或删除资源 方法 如上图所示。
  • 您可以请求修改，然后收到修改响应，如下所述。
  • 例如，我们使用了 邮递员应用程序 工具 API 和界面如下所示。

  • 正如您在上图中看到的，您可以输入 API URL（例如链接到 LabCollector的菌株和细胞模块），完成修改并点击发送后，您将收到回复。
    如果一切正确并且请求已执行，则 Postman 应用程序中的响应将如下所示。
  • 1. 您可以在此处选择请求的方式。 （获取、发布、放置和删除）
  • 2. 对 API 的请求需要一些特定的 HTTP/HTTPS 标头。
  • 3. 接受 header 定义请求所需的响应格式：文本/XML（默认）或应用程序/JSON。
  • 4. X-LC-APP-验证 您在其中放置应用程序令牌的标头，这是授权您向 API 发出请求所必需的。
  • 5. X-LC-APP-字符集 header 定义应用程序的字符编码。它允许 API 使用适当的编码发回响应，并将您的 POST 和 PUT 请求正确转换为 LabCollector的字符编码 (ISO 8859-1)。

3.API用于 LabCollector: 统一资源标识符 (URI)

  • 统一资源标识符 (URI) 是明确标识特定资源的字符串。

  • URL 重写开启 (mod_rewrite的)
    请注意： 您必须在 apache 文件中执行此操作。

    [路径_TO_LABCOLLECTOR]/webservice/v2/[模块]

  • 普通网址：

    [路径_TO_LABCOLLECTOR]/webservice/v2/[模块]?name=[关键字]
  • 了解有关 URI 以及如何使用它的更多信息 LabCollector请 阅读我们的手册 LabCollector API 第 7-17 页。

4. API示例

  • 中的代码示例 C# 
    字符串 url = _Url.Replace("{id}", txtDataID.Text); var client = new RestSharp.RestClient(url);客户端.超时= 900000; var request = new RestSharp.RestRequest();请求.超时= 900000;请求.Method = Method.GET; request.AddHeader("X-LC-APP-Auth", token); request.AddHeader("接受", "text/xml"); ///////////////////// IRestResponse 响应 = client.Execute(request);字符串结果=响应.内容；
  • 中的代码示例 PHP: 
    从 API 接收标头信息 $API_response = curl_exec($curl);卷曲_关闭（$卷曲）；回显$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', '内容类型:'.$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_CONNECTTIMEOUT,0);curl_setopt($curl, CURLOPT_HEADER); , true); //可选 -> 从 API 接收标头信息 $API_response = curl_exec($curl); echo($API_response);

5. LSM API

  • 实验室服务管理器 (LSM) 是我们的服务核心/测试实验室的附加组件。
  • 如前所述，您可以配置连接到 LSM 插件（通过选中插件前面的框），如下所示 第1节 以上。
  • 您可以使用 API 来使用 GET 方法来读取/检索有关您在测试中使用的各种参数的信息，例如样品名称、测定状态、批次信息、作业 ID 等，
  • 请我们的 有关 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. 工作流程API *新

  • 想要遵循严格的逐步验证协议的机构可以使用工作流程插件。
  • LabCollector 现在可以在 API 的帮助下连接到工作流程插件。
  • 借助工作流 API，您现在可以执行给定的作业或完成一个节点。 （节点是工作流附加组件中的流程或步骤）
  • 了解有关工作流 API 以及如何使用它的更多信息 LabCollector请 阅读我们的 Workflow API 手册.

8. 故障排除（错误消息）

9. 附件-Web服务API

  • 附件描述了用于正常运行的干净 URL。
  • 附件描述了与相关模块和描述一起使用的所有 URI，并告知您要使用的方法（PUT、POST 等）。
  • 您需要启用 apache 引擎以使用附件中描述的 URI。阅读或阅读知识库文章 网络服务/apache 设置。
  • 了解有关 LSM API 以及如何使用它的更多信息 LabCollector请 阅读我们的 API 手册 第 33-37 页。

相关话题：