Conecte un periférico webhook

Actualizado

Nota: Este artículo es técnico, por lo que recomendamos que usted cuente con alguien con la experiencia técnica adecuada. Si tiene alguna pregunta, contacte con nosotros en support@azumuta.com.

Un periférico webhook permite que un sistema externo rellene la respuesta de una product check. Cuando el operador llega al paso, Azumuta llama a su webhook, lee el valor de la respuesta y lo utiliza como respuesta. Por ejemplo, un servicio de medición puede devolver el valor medido de una pieza, de modo que el operador no lo escriba.

Los servidores de Azumuta llaman al webhook, por lo que usted no necesita el Hub ni ningún software en la estación de trabajo.

Qué necesita

  • A webhook endpoint que los servidores de Azumuta puedan alcanzar. Debe ser accesible desde Internet, no solo desde el equipo del operador. Para rellenar una respuesta, tiene que devolver JSON.
  • Los permisos para gestionar periféricos y dispositivos en Gestión, y para editar instrucciones de trabajo.
  • A supported check. Un periférico webhook funciona con las comprobaciones OK/NOK, Number, Single Line y Paragraph. La comprobación Procedure también puede usar uno, o su propia acción webhook. Vea Procedure check.

Crear el periférico

  1. Haga clic en Peripherals bajo Management.
  2. Haga clic en el botón amarillo con el símbolo +.
  3. Escriba un Name y seleccione o cree el Peripheral group.
  4. En How to connect?, seleccione Webhook
  5. Rellene los campos del webhook.
  6. Cuando termine, haga clic en Add.

Campos del webhook

  • Webhook URL: la dirección http o https completa de su endpoint.
  • Method: POST, GET, PUT o PATCH.
  • Authentication: cómo Azumuta se identifica ante su endpoint: None, Header, Basic u OAuth client credentials. Funcionan de la misma manera para los triggers de webhook. Vea Authentication.
  • Payload format y Webhook payload: Con Azumuta format, su payload se envía dentro del cuerpo JSON de Azumuta, junto a los campos del evento. Con JSON, XML, CSV o Text, solo se envía su payload, con el tipo de contenido correspondiente. Puede usar parameters en el payload.
  • When to run the webhook:
    • Automatic on first visit: la primera vez que el operador abre el paso.
    • Automatic on every visit: cada vez que el operador abre el paso.
    • Manual: el operador pulsa un botón.
  • Response format: JSON.
  • Webhook result parameter: dónde Azumuta encuentra la respuesta en la respuesta JSON, por ejemplo data.result.value para una respuesta como { "data": { "result": { "value": 17.3 } } }. Déjelo vacío para usar toda la respuesta.
  • Webhook remark parameter: dónde Azumuta encuentra un mensaje de observación en la respuesta JSON.

Azumuta añade el número de orden de producto y los IDs de la instrucción de trabajo y del registro (cuando proceda) a la llamada: como parámetros URL para GET, y en el cuerpo JSON para el Azumuta format.

Añadir el periférico a un dispositivo

Una comprobación encuentra su periférico a través del dispositivo y del grupo de periféricos. Añada el periférico a cada dispositivo donde los operadores ejecuten la instrucción de trabajo:

  1. Haga clic en Devices bajo Management.
  2. Haga clic en el icono ⋮ (tres puntos) junto al dispositivo, y haga clic en Edit device.
  3. Haga clic en la pestaña Peripherals.
  4. En Peripherals for instruction checks, seleccione el periférico webhook.
  5. Haga clic en Save.

Usar el periférico en una comprobación

  1. Abra el paso de la instrucción y haga clic en la pestaña Check.
  2. Seleccione una comprobación compatible.
  3. En Peripheral options, seleccione el Peripheral group de su periférico webhook. También puede aplicar un peripheral preset.
  4. Ajuste las opciones si es necesario:
    • Payload: reemplaza el payload configurado en el periférico para esta comprobación. Déjelo vacío para usar el del periférico. Escríbalo en el formato de payload del periférico.
    • Automatically submit answer after: envía la respuesta de 0 a 10 segundos después de que se rellene. No disponible para la comprobación OK/NOK.
    • Allow manually entering answer: permite que el operador escriba o cambie la respuesta. Está activado por defecto.

Ejemplo

Un servicio de calidad devuelve el valor medido de una pieza. Su endpoint es https://qc.example.com/api/measurement y responde con:

{
  "data": {
    "value": 17.3,
    "remark": "Within tolerance"
  }
}

Para usarlo en una comprobación Number:

  1. Cree un grupo de periféricos para la comprobación Number, por ejemplo "External measurement".
  2. Cree un periférico webhook en ese grupo, con Method POST, Webhook result parameter data.value, Webhook remark parameter data.remark, y When to run the webhook establecido en Automatic on first visit.
  3. Añada el periférico al dispositivo que usan los operadores.
  4. Añada una comprobación Number al paso de la instrucción y seleccione el grupo en Peripheral options.

Cuando el operador abre el paso, Azumuta llama al endpoint y rellena 17.3 como respuesta.

Si su endpoint no está disponible

Para permitir que los operadores continúen mientras su endpoint está caído, marque Disable peripheral temporarily en el periférico. Los operadores podrán entonces escribir las respuestas a mano. Vea Use a peripheral device.

Elija el webhook adecuado

  • Para rellenar la respuesta de una comprobación desde un sistema externo, use un periférico webhook, como se describe aquí.
  • Para validar un paso, use la acción webhook de una Procedure check.
  • Para notificar a otro sistema cuando ocurre algo, use un webhook trigger.
En esta página