Eenvoudige invoerintegratie

Bijgewerkt

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

Wat Is Simple Entry Integration?

Een veelvoorkomend gebruik van simple entry-integratie is automatische navigatie naar productorders. Een operator kan de barcode van een productorder scannen en het scherm wordt automatisch doorgestuurd naar die productorder, zodat hij of zij direct op het apparaat aan die productorder kan beginnen te werken.

docs new feature simple entry integrations

Om dit mogelijk te maken hebben we een generieke Simple Entry Integration gemaakt, beschikbaar in de Integrations-sectie van uw bedrijfsinstellingen. Om naar deze sectie te navigeren:

  1. Klik op Settings onder Management.
  2. Klik op Integrations onder Integrations.

docs what is simple entry integration 2

De vooraf ingevulde URL /api/integrations/generic/v1/getOrderByBarcode is een generieke implementatie van het simple entry-proces. Deze configuratie maakt een eenvoudige stroom mogelijk waarbij het scannen en invoeren van een productorder-identificatie een bestaande productorder opent.

Opmerking: Dit werkt alleen als de productorder al bestaat en de gescande code exact overeenkomt met de productidentificatie in Azumuta.

Als u meer geavanceerde functionaliteit nodig heeft, zoals het automatisch aanmaken van een productorder die nog niet bestaat, zie dan deze sectie.

Nadat u een Simple Entry Integration in uw bedrijfsinstellingen hebt ingesteld, werkt u de apparaatinstellingen bij waar u deze wilt gebruiken. Ga naar het Product orders-tabblad en controleer zorgvuldig de hieronder gemarkeerde instellingen:

docs what is simple entry integration 3

Maak een aangepaste simple entry-integratie

Als u dit proces met uw eigen bedrijfslogica wilt uitbreiden, kunt u een aangepaste integratie maken.

Wanneer een apparaat is geconfigureerd om simple entry te gebruiken, stuurt het een verzoek naar de URL die is opgegeven in het simpleEntryEndpoint-veld. Het config-veld kan leeg worden gelaten.

docs how to create a custom simple entry integration

Na het scannen van een barcode op het geconfigureerde apparaat zal onze service een GET-verzoek sturen naar de URL die is opgegeven in het simpleEntryEndpoint-veld.

Het verzoek bevat een queryparameter met de naam barcode, die de gescande code of invoer op het apparaat vertegenwoordigt.

Opmerking: De barcode wordt URL-geëncodeerd

Authenticatie

De Authentication-instelling op de integratie bepaalt hoe Azumuta zichzelf identificeert bij uw endpoint. Het biedt dezelfde opties als een procedure check webhook.

  • Legacy (API key of the calling device) - de standaardinstelling voor integraties die zijn gemaakt voordat deze optie bestond. Azumuta verstuurt de API-sleutel van het apparaat dat de barcode heeft gescand in een x-api-key-header. Die sleutel authenticeert het apparaat tegen de Azumuta REST API, zodat uw endpoint ermee terug kan bellen naar Azumuta, maar het authenticeren van Azumuta naar u gebeurt hiermee niet. Kies een van de onderstaande opties voor een nieuwe integratie.
  • None - er wordt geen credential verzonden.
  • Header - een header van uw keuze, met ofwel een waarde die u invoert of de API-sleutel van een API device die u selecteert. De headernaam staat standaard op X-API-Key.
  • Basic - een gebruikersnaam en wachtwoord, verzonden als een Authorization: Basic-header.
  • OAuth client credentials - Azumuta vraagt een token aan bij uw token-URL met een client ID en client secret, en stuurt dit vervolgens als een Authorization: Bearer-header. De token-URL moet https gebruiken.

Het kiezen van iets anders dan Legacy vervangt de x-api-key-header in plaats van deze toe te voegen. Het scannende apparaat wordt nog steeds geïdentificeerd via de queryparameters deviceId en deviceName.

Geheimen die u invoert (een headervalue, een wachtwoord, een client secret) worden versleuteld opgeslagen en worden nooit teruggestuurd naar de browser. Wanneer u de integratie opnieuw opent, is het veld leeg; laat het leeg om het opgeslagen geheim te behouden. Het wijzigen van de endpoint-URL (of, voor OAuth, de token-URL) wist het opgeslagen geheim, dus u moet het opnieuw invoeren.

Voorbeeldverzoek

Verzoek: url: ?barcode=&deviceId=&deviceName= headers: { x-api-key: }

Bovenstaande header is de Legacy-standaard. Bij elke andere Authentication-optie wordt de geconfigureerde credential in plaats daarvan verzonden.

Nadat uw aangepaste logica is verwerkt, moet de integratie reageren met een JSON-object dat het identifier-veld bevat. Content-type van het antwoord moet application/json zijn.

Voorbeeldantwoord

{ identifier: “” }

Maak automatisch een productorder aan

Een veelgevraagde functionaliteit van klanten is de mogelijkheid om automatisch een productorder aan te maken voor de gescande code (als de productorder nog niet bestaat).

Dit kan eenvoudig worden gerealiseerd met één aanroep naar de Products Create REST API. Open Help (het vraagteken rechtsboven) → API docs, en open vervolgens de Products Create-endpoint. Authenticeer met een API-sleutel van een Api Device. Meer over toegang tot de documentatie: Azumuta’s REST API.

U kunt een POST-verzoek naar het create product-endpoint doen met de volgende parameters:

  • returnExisting: true — Dit maakt geen nieuw product aan maar retourneert het bestaande product voor het geval de productorder al bestaat.

  • activate: true — Activeert de productorder automatisch bij aanmaak. Het activeren van een productorder maakt deze zichtbaar in de operatorinterface. Deze actie zorgt ervoor dat de bijbehorende werkvoorschriften worden vergrendeld op hun laatste goedgekeurde versies.

Op deze pagina