Integración de entrada simple
Nota: Este es un artículo de alto contenido técnico. Por ello, le recomendamos contar con su departamento de TI al consultarlo. Si tiene alguna pregunta o solicitud, póngase en contacto con nosotros a través de support@azumuta.com; estaremos encantados de ayudarle.
¿Qué es la Simple Entry Integration?
Un caso de uso habitual de la simple entry integration es la navegación automática a órdenes de producto. Un operario puede escanear el código de barras de una orden de producto y su pantalla se redirigirá automáticamente a dicha orden, de modo que pueda comenzar a trabajar en ella inmediatamente desde su dispositivo.
Para habilitar esto, hemos creado una Simple Entry Integration genérica, disponible en la sección Integraciones de la configuración de su empresa. Así es como puede llegar a esa sección.
- Haga clic en Configuración bajo Gestión.
- Haga clic en Integraciones bajo Integraciones.
La URL rellenada por defecto /api/integrations/generic/v1/getOrderByBarcode es una implementación genérica del proceso de simple entry. Esta configuración permite un flujo sencillo en el que al escanear e introducir un identificador de orden de producto se abrirá la orden de producto existente.
Nota: Esto solo funciona si la orden de producto ya existe y el código escaneado coincide exactamente con el identificador del producto en Azumuta.
Si necesita funcionalidades más avanzadas, como crear automáticamente una orden de producto que aún no existe, consulte esta sección.
Tras configurar una Simple Entry Integration en la configuración de su empresa, actualice la configuración del dispositivo donde quiera usarla. Vaya a la pestaña Órdenes de producto y revise detenidamente los ajustes resaltados a continuación:
Crear una simple entry integration personalizada
Si desea ampliar este proceso con su propia lógica de negocio, puede crear una integración personalizada.
Cuando un dispositivo está configurado para usar simple entry, enviará una solicitud a la URL especificada en el campo simpleEntryEndpoint. El campo de configuración puede dejarse en blanco.
Después de escanear un código de barras en el dispositivo configurado, nuestro servicio enviará una solicitud GET a la URL proporcionada en el campo simpleEntryEndpoint.
La solicitud incluirá un parámetro de consulta llamado barcode, que representa el código escaneado o la entrada en el dispositivo.
Nota: El barcode estará codificado en la URL
Autenticación
La opción Authentication en la integración decide cómo se identifica Azumuta ante su endpoint. Ofrece las mismas opciones que un webhook de comprobación de procedimiento.
- Legacy (API key of the calling device) - el valor predeterminado para integraciones creadas antes de que existiera esta opción. Azumuta envía la API key del dispositivo que escaneó el código de barras en un encabezado
x-api-key. Esa clave autentica el dispositivo frente a la REST API de Azumuta, de modo que su endpoint puede llamar de vuelta a Azumuta con ella, pero no autentica a Azumuta ante usted. Para una integración nueva, prefiera una de las opciones que siguen. - None - no se envían credenciales.
- Header - un encabezado de su elección, que contiene ya sea un valor que introduzca o la API key de un API device que seleccione. El nombre del encabezado por defecto es
X-API-Key. - Basic - un nombre de usuario y contraseña, enviados como un encabezado
Authorization: Basic. - OAuth client credentials - Azumuta solicita un token a su token URL con un client ID y un client secret, y luego lo envía como un encabezado
Authorization: Bearer. La URL del token debe usar https.
Elegir cualquier opción distinta de Legacy reemplaza el encabezado x-api-key en lugar de añadirlo. El dispositivo que realiza el escaneo sigue siendo identificado mediante los parámetros de consulta deviceId y deviceName.
Los secretos que introduzca (un valor de encabezado, una contraseña, un client secret) se cifran antes de almacenarse y nunca se envían de vuelta al navegador. Cuando vuelva a abrir la integración, el campo aparece en blanco; déjelo en blanco para mantener el secreto almacenado. Cambiar la URL del endpoint (o, en el caso de OAuth, la URL del token) borra el secreto almacenado, por lo que deberá introducirlo de nuevo.
Ejemplo de solicitud
Request:
url:
El encabezado anterior es el valor predeterminado Legacy. Con cualquier otra opción de Authentication, la credencial que haya configurado se envía en su lugar.
Tras procesar su lógica personalizada, la integración debería responder con un objeto JSON que contenga el campo identifier. El Content-Type de la petición debe ser application/json.
Ejemplo de respuesta
{ identifier: “
Crear una orden de producto automáticamente
Una solicitud de funcionalidad habitual que recibimos con frecuencia de clientes es la posibilidad de crear automáticamente una orden de producto para el código escaneado (si la orden de producto aún no existe).
Esto se puede lograr fácilmente mediante una única llamada a la REST API Products Create. Abra Help (el signo de interrogación en la esquina superior derecha) → API docs, y luego abra el endpoint Products Create. Autentíquese con una API key de un Api Device. Más información sobre cómo acceder a la documentación: Azumuta’s REST API.
Puede realizar una solicitud POST al endpoint de creación de producto usando los siguientes parámetros:
returnExisting: true — Esto no creará un producto nuevo, sino que devolverá el producto existente en caso de que la orden de producto ya exista.
activate: true — Active automáticamente la orden de producto al crearla. Activar una orden de producto la hace visible en la interfaz del operario. Esta acción garantiza que las instrucciones de trabajo asociadas queden bloqueadas en sus últimas versiones aprobadas.