Introducción a los LabCollector API - LabCollector

Buscar la base de conocimiento por palabra clave

Estas aquí:
â † Todos los temas
RESUMEN:

API es la interfaz de programación de aplicaciones, una interfaz informática que define las interacciones entre múltiples intermediarios de software. En palabras simples, permite que dos aplicaciones se comuniquen entre sí. Por ejemplo, cuando usas cualquier aplicación en tu móvil para ver Facebook, Instagram o la aplicación del tiempo, estás usando la API. Del mismo modo, si está utilizando LabCollector LIMS y desea conectarse a software de terceros, puede conectarse a través de API.

La LabCollector La interfaz de programación de aplicaciones (API) de servicios web permite que aplicaciones de terceros interactúen con ambos. LabCollectorLa base de datos (módulos) y LabCollector complementos (ELN y LSM).

AgileBio ofrece API para (se explican en las secciones siguientes): -

  • API LC principal: Usando esto puedes trabajar/extraer datos de módulos (muestras...), almacenamiento, obtener/poner archivos...
  • ELN API: Esto le ayuda a trabajar en libros/páginas (obtener/agregar), cargar archivos/imágenes
  • API LSM: Con esto puedes trabajar en análisis/servicios (agregar trabajos, actualizar resultados, obtener resultados…)
  • API de WF (¡Nuevo!): Esto puede ayudar a activar nuevos flujos de trabajo, cambiar el estado

La API se basa en una arquitectura de transferencia de estado representacional (REST) ​​que permite el acceso a digitales a través del Identificador Uniforme de Recursos (URI) y acciones sobre ellos. 

La API también proporciona seguridad en términos de integridad de los datos. Por ejemplo, cuando dos aplicaciones hablan con API, solo hablan en términos de pequeños paquetes de datos que son necesarios. Por ejemplo, cuando pides un artículo en Amazon. Simplemente transmite los artículos que desea y luego se los entregan. No te encuentras con todo el proceso de fabricación del artículo, embalaje o transporte, etc. Los mismos datos en LabCollector Solo es visible en algunas partes (recursos) que se pueden modificar con la ayuda de API.

Siga estos pasos para configurar el LabCollector API: -

1. Configuración general de API

2. Cómo utilizar API 

3. API para LabCollector: Identificador uniforme de recursos (URI)

4. Ejemplos de API

5. API LSM

6. ELN API

7. API de flujo de trabajo *NUEVO

8. Solución de problemas (mensajes de error)

9. Anexo-API de servicio web

1. Configuración general de API

  • Para configurar API en LabCollector tienes que declarar tu solicitud en LabCollector.
  • Para hacerlo, inicie sesión en LabCollector como herramienta de edición del superadministrador. 
    * Por favor lea nuestra KB para ver ¿Cuáles son los permisos de superadministrador en LabCollector.
  • En LabCollector cuando inicies sesión ve a ADMIN. -> CONFIGURACIÓN -> API DE SERVICIOS WEB

  • Verá la siguiente página donde puede definir una nueva aplicación a la que desea conectarse LabCollector a través de la API.

 

  • 1. NOMBRE: Aquí puede agregar el nombre de su aplicación. Por ejemplo, hemos agregado el nombre de nuestro complemento, que es recepción de muestras.
  • 2. OPERADOR POR DEFECTO: Aquí puede ingresar la persona que desea que sea el operador de esta API. Si no agrega el operador aquí, deberá agregarlo durante cada solicitud que realice a través de API.
  • 3. RESTRICCIÓN DE IP: Esta opción le permite una capa de seguridad, ya que puede definir aquí qué direcciones IP (protocolo de Internet) pueden funcionar en la API que está definiendo. Recuerde que si elige "sí", el cuadro para ingresar la dirección IP aparecerá solo después de guardar su configuración.
  • 4. MÓDULOS CONECTADOS A ESTA APLICACIÓN: Hay 12 módulos por defecto presentes en LabCollector. Aparte de esto, también puede crear nuevos complementos personalizados según sus requisitos. Todos los módulos predeterminados y personalizados y los complementos estarán presentes aquí y podrá elegir qué módulos desea que interactúen con la API.
  • 5. AÑADIR: Una vez que haya definido su configuración, puede hacer clic en Agregar y su API se verá como se muestra a continuación.
  • A. Ahora puede agregar la dirección IP y hacer clic en "Agregar nueva IP".
  • B. Al hacer clic en el icono de actualización, puede editar la configuración de su API.
  • C. Este es su número de token que puede usarse para conectarse a la API. Incluso puedes crear un código de barras y copiarlo haciendo clic en del icono.
 NOTA: Nota: Para utilizar esta función, debe activar Curl en sus preferencias de PHP. En Linux, instale el paquete PHP-Curl. En Windows y con nuestro instalador automático, edite PHP.ini y descomente las extensiones para Curl (extensión=php_curl.dll).

2. Cómo utilizar la API 

  • El diálogo de comunicación entre aplicaciones remotas (de terceros) y LabCollector Se basa en el protocolo HTTP 1.1. (*Para comprobar qué es el recurso, consulte la imagen de arriba)

  • Puede modificar, leer, crear o eliminar un recurso mediante OBTENER, POST, PUT y DELETE. Método como se muestra en la imagen de arriba.
  • Puede solicitar una modificación y luego recibir la respuesta a la modificación como se explica a continuación.
  • Por ejemplo, utilizamos el Aplicación CARTERO para API y la interfaz se ve a continuación.

  • Como puede ver en la imagen de arriba, puede escribir la URL de la API (por ejemplo, enlace a LabCollector's Strains & Cells module) y después de terminar las modificaciones y presionar enviar, recibirá una respuesta.
    Si todo está correcto y la solicitud se ha realizado, la respuesta se verá como se muestra a continuación en la aplicación Postman.
  • 1. Aquí puede elegir el método de su solicitud. (OBTENER, PUBLICAR, PONER y ELIMINAR)
  • 2. Una solicitud a API requiere algún HTTP/HTTPS específico encabezados.
  • 3. La Aceptar El encabezado define el formato de respuesta deseado de su solicitud, texto/XML (predeterminado) o aplicación/JSON.
  • 4. La Autenticación X-LC-APP encabezado donde coloca su token de aplicación, que es necesario para autorizar su solicitud a la API.
  • 5. La Juego de caracteres X-LC-APP El encabezado define la codificación de caracteres de su aplicación. Permite que la API devuelva la respuesta con la codificación adecuada y convierta correctamente sus solicitudes POST y PUT al formato LabCollectorcodificación de caracteres (ISO 8859-1).

3. API para LabCollector: Identificador uniforme de recursos (URI)

  • Un identificador uniforme de recursos (URI) es una cadena de caracteres que identifica sin ambigüedades un recurso en particular.

  • Reescritura de URL activada (mod_rewrite)
    Nota: Tienes que hacer esto en tu archivo apache.

    [CAMINO A_LABCOLLECTOR]/webservice/v2/[MÓDULO]

  • URL normales:

    [CAMINO A_LABCOLLECTOR]/webservice/v2/[MÓDULO]?nombre=[PALABRA CLAVE]
  • Para saber más sobre el URI y cómo usarlo con LabCollector, Por favor lea nuestro manual sobre LabCollector API página 7-17.

4. Ejemplos de API

  • Ejemplo de códigos en C# 
    URL de cadena = _Url.Replace("{id}", txtDataID.Text); cliente var = nuevo RestSharp.RestClient(url); cliente.Tiempo de espera = 900000; solicitud var = nuevo RestSharp.RestRequest(); solicitud.Tiempo de espera = 900000; solicitud.Método = Método.GET; request.AddHeader("X-LC-APP-Auth", token); request.AddHeader("Aceptar", "texto/xml"); //////////////////// IRestResponse respuesta = client.Execute(solicitud); resultado de cadena = respuesta.Contenido;
  • Ejemplo de códigos en PHP: 
    PARA RECIBIR INFORMACIÓN DEL ENCABEZADO DE LA API $API_response = curl_exec($curl); curl_close($curl); eco $API_respuesta; ?>
  • Ejemplo de API a enviar un archivo: 
    labcollector.rar'; $file_info = getimagesize($file_path); $tamaño_archivo = tamaño del archivo($ruta_archivo); $actualización = matriz( 'archivo_informe_salud[0]' => '@'.$ruta_archivo.";nombre de archivo=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', 'Tipo de contenido: '.$file_info['mime'])); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_RETURNTRANSFER, verdadero); ; curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT"); curl_setopt($curl, CURLOPT_POSTFIELDS, $actualización); , verdadero); //OPCIONAL -> PARA RECIBIR INFORMACIÓN DEL ENCABEZADO DE LA API $API_response = curl_exec($curl);

5. API LSM

  • Lab Service Manager (LSM) es nuestro complemento para laboratorios de pruebas y núcleo de servicios.
  • Como se explicó anteriormente, puede configurar para conectarse al complemento LSM (marcando la casilla frente a los complementos) como se muestra en sección 1 anterior.
  • Puede utilizar API para utilizar el método GET para leer/recuperar información sobre varios parámetros que utiliza en una prueba, como el nombre de la muestra, el estado del ensayo, la información del lote, la identificación del trabajo, etc.
  • Por favor nuestro KB sobre API LSM.
  • Para saber más sobre la API LSM y cómo usarla con LabCollector, Por favor lea nuestro manual sobre API página 18-28.

6. ELN API

  • Cuaderno de laboratorio electrónico (ELN) el complemento es la sustitución de un cuaderno de laboratorio de papel. 
  • Como se explicó anteriormente, puede configurar para conectarse al ELN complemento (marcando la casilla delante de complementos como se muestra en sección 1 anterior.
  • Puede utilizar API para utilizar los métodos GET y POST para leer/recuperar información sobre datos de libros, experimentos y páginas.
  • Por favor nuestro KB en ELN API.
  • Para saber más sobre el ELN API y cómo usarla con LabCollector, Por favor lea nuestro manual sobre ELN API página 29-30.

7. API de flujo de trabajo *NUEVO

  • El complemento de flujo de trabajo puede ser utilizado por institutos que quieran seguir un estricto protocolo de validación paso a paso.
  • LabCollector ahora ofrece conectarse al complemento de flujo de trabajo con la ayuda de API.
  • Con la ayuda de la API de flujo de trabajo, ahora puede ejecutar un trabajo determinado o completar un nodo. (un nodo es un proceso o paso en un complemento del flujo de trabajo)
  • Para saber más sobre la API de flujo de trabajo y cómo usarla con LabCollector, Por favor lea nuestro manual sobre API de flujo de trabajo.

8. Solución de problemas (mensajes de error)

9. Anexo-API de servicio web

  • El anexo describe las URL limpias que se deben utilizar para funcionar correctamente.
  • El anexo describe todos los URI que se utilizarán con el módulo relacionado y la descripción y también le informa sobre el método (PUT, POST, etc.) que se utilizará para el mismo.
  • Debe habilitar el motor Apache para utilizar el URI descrito en el Anexo. Leer o KB en Configuración del servicio web/apache.
  • Para saber más sobre la API LSM y cómo usarla con LabCollector, Por favor lea nuestro manual sobre API página 33-37.

Temas relacionados: