Verbind een webhook-randapparaat

Bijgewerkt

Opmerking: Dit artikel is technisch, dus wij raden u aan iemand met de juiste technische expertise erbij te betrekken. Als u vragen heeft, neem contact op met support@azumuta.com.

Een webhook-peripheral laat een extern systeem het antwoord van een product check invullen. Wanneer de operator de stap bereikt, roept Azumuta uw webhook aan, leest de waarde uit de response en gebruikt die als antwoord. Bijvoorbeeld: een meetsysteem kan de gemeten waarde van een onderdeel terugsturen, zodat de operator deze niet handmatig hoeft in te voeren.

De servers van Azumuta roepen de webhook aan, dus u heeft de Hub of enige software op het werkstation niet nodig.

Wat u nodig heeft

  • Een webhook-endpoint dat bereikbaar is vanaf de servers van Azumuta. Het moet bereikbaar zijn vanaf internet, niet alleen vanaf de computer van de operator. Om een antwoord in te vullen moet het JSON teruggeven.
  • De rechten om peripherals en devices te beheren onder Management, en om werkinstructies te bewerken.
  • Een ondersteunde check. Een webhook-peripheral werkt met de OK/NOK, Number, Single Line en Paragraph checks. De Procedure-check kan er ook een gebruiken, of zijn eigen webhook-actie. Zie Procedure check.

Randapparaat aanmaken

  1. Klik op Peripherals onder Management.
  2. Klik op de gele plus knop.
  3. Typ een Name en selecteer of maak de Peripheral group.
  4. Onder How to connect?, selecteer Webhook
  5. Vul de webhook-velden in.
  6. Als u klaar bent, klik op Add.

Webhook-velden

  • Webhook URL: het volledige http- of https-adres van uw endpoint.
  • Method: POST, GET, PUT of PATCH.
  • Authentication: hoe Azumuta zich identificeert bij uw endpoint: None, Header, Basic of OAuth client credentials. Deze werken op dezelfde manier voor webhook-triggers. Zie Authentication.
  • Payload format en Webhook payload: Met Azumuta format wordt uw payload verzonden binnen de JSON-body van Azumuta, naast de eventvelden. Met JSON, XML, CSV of Text wordt alleen uw payload verzonden, met de bijhorende content-type. U kunt parameters gebruiken in de payload.
  • When to run the webhook:
    • Automatic on first visit: de eerste keer dat de operator de stap opent.
    • Automatic on every visit: elke keer dat de operator de stap opent.
    • Manual: de operator drukt op een knop.
  • Response format: JSON.
  • Webhook result parameter: waar Azumuta het antwoord in de JSON-response vindt, bijvoorbeeld data.result.value voor een response zoals { "data": { "result": { "value": 17.3 } } }. Laat empty om de hele response te gebruiken.
  • Webhook remark parameter: waar Azumuta een opmerkingtekst in de JSON-response vindt.

Azumuta voegt het productordernummer en de werkinstructie- en recording-IDs (indien van toepassing) toe aan de call: als URL-parameters voor GET, en in de JSON-body voor het Azumuta format.

Het randapparaat aan een device toevoegen

Een check vindt zijn peripheral via het device en de peripheral group. Voeg het randapparaat toe aan elk device waar operators de werkinstructie uitvoeren:

  1. Klik op Devices onder Management.
  2. Klik op het ⋮ (drie-punt) icoon naast het device, en klik op Edit device.
  3. Klik op het Peripherals tabblad.
  4. Onder Peripherals for instruction checks, selecteer het webhook-peripheral.
  5. Klik op Save.

Het randapparaat gebruiken bij een check

  1. Open de instructiestap en klik op het Check tabblad.
  2. Selecteer een ondersteunde check.
  3. Onder Peripheral options, selecteer de Peripheral group van uw webhook-peripheral. U kunt ook een peripheral preset toepassen.
  4. Pas de opties aan indien nodig:
    • Payload: vervangt de payload die op het peripheral is ingesteld voor deze check. Laat leeg om die van het peripheral te gebruiken. Schrijf het in het payload-formaat van het peripheral.
    • Automatically submit answer after: verstuurt het antwoord 0 tot 10 seconden nadat het is ingevuld. Niet beschikbaar voor de OK/NOK-check.
    • Allow manually entering answer: laat de operator het antwoord typen of wijzigen. Dit staat standaard aan.

Voorbeeld

Een kwaliteitsdienst stuurt de gemeten waarde van een onderdeel terug. Uw endpoint is https://qc.example.com/api/measurement en antwoordt met:

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

Om dit te gebruiken bij een Number-check:

  1. Maak een peripheral group voor de Number-check, bijvoorbeeld "External measurement".
  2. Maak een webhook-peripheral in die groep, met Method POST, Webhook result parameter data.value, Webhook remark parameter data.remark, en When to run the webhook ingesteld op Automatic on first visit.
  3. Voeg het peripheral toe aan het device dat operators gebruiken.
  4. Voeg een Number-check toe aan de instructiestap, en selecteer de groep onder Peripheral options.

Wanneer de operator de stap opent, roept Azumuta het endpoint aan en vult 17.3 in als antwoord.

Als uw endpoint niet beschikbaar is

Om operators te laten doorgaan terwijl uw endpoint down is, vink Disable peripheral temporarily aan op het peripheral. Operators kunnen dan de antwoorden handmatig invoeren. Zie Use a peripheral device.

Kies de juiste webhook

  • Om het antwoord van een check vanuit een extern systeem in te vullen, gebruikt u een webhook-peripheral, zoals hier beschreven.
  • Om een stap te valideren, gebruikt u de webhook-actie van een Procedure check.
  • Om een ander systeem te informeren wanneer er iets gebeurt, gebruikt u een webhook trigger.
Op deze pagina