Integración de entrada sencilla
Nota: Este artículo es técnico, por lo que recomendamos involucrar a alguien con la experiencia técnica adecuada. Si tiene alguna pregunta, contacte con nosotros en support@azumuta.com.
¿Qué es Simple Entry Integration?
Un caso de uso común de la simple entry integration es la navegación automática a las ó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 esa orden, de modo que pueda comenzar a trabajar en ella de inmediato desde su dispositivo.
Para habilitar esto, hemos creado una Simple Entry Integration genérica, disponible en la sección Integrations de la configuración de su empresa. Para acceder a esta sección:
- Haga clic en Settings bajo Management.
- Haga clic en Integrations bajo Integrations.
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 escanear e introducir un identificador de orden de producto abrirá una 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 funcionalidad más avanzada, como crear automáticamente una orden de producto que aún no exista, consulte esta sección.
Después de configurar una Simple Entry Integration en la configuración de su empresa, actualice los ajustes del dispositivo donde quiera utilizarla. Vaya a la pestaña Product orders y revise con atención las opciones resaltadas 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 petición a la URL especificada en el campo simpleEntryEndpoint. El campo de configuración puede dejarse en blanco.
Tras escanear un código de barras en el dispositivo configurado, nuestro servicio enviará una petición GET a la URL indicada en el campo simpleEntryEndpoint.
La petición 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 Azumuta se identifica 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 al dispositivo frente a la Azumuta REST API, por lo que su endpoint puede realizar llamadas 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ía ninguna credencial.
- Header - un encabezado a su elección, que contiene bien un valor que introduzca usted o bien la API key de un Api Device que seleccione. El nombre del encabezado por defecto es
X-API-Key. - Basic - un usuario y una 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 (el valor de un encabezado, una contraseña, un client secret) se cifran antes de almacenarse y nunca se envían de nuevo al navegador. Cuando vuelva a abrir la integración, el campo aparecerá en blanco; déjelo en blanco para mantener el secreto almacenado. Cambiar la URL del endpoint (o, para OAuth, la URL del token) borra el secreto almacenado, por lo que deberá introducirlo de nuevo.
Ejemplo de petición
Request:
url:
El encabezado anterior es el valor Legacy por defecto. Con cualquier otra opción de Authentication, se enviará la credencial que haya configurado en su lugar.
Después de procesar su lógica personalizada, la integración debe responder con un objeto JSON que contenga el campo identifier. El Content-type de la respuesta debe ser application/json.
Ejemplo de respuesta
{ identifier: “
Crear una orden de producto automáticamente
Una petición habitual que recibimos de los clientes es la posibilidad de crear automáticamente una orden de producto para el código escaneado (si la orden aún no existía).
Esto se puede lograr fácilmente usando una sola llamada al 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 hacer una petición 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 — Activa automáticamente la orden de producto al crearla. Activar una orden de producto la hace visible en la interfaz de operario. Esta acción garantiza que las instrucciones de trabajo asociadas queden bloqueadas en sus últimas versiones aprobadas.