Einfache Eingabe-Integration
Hinweis: Dies ist ein hoch technischer Artikel. Wir empfehlen daher, Ihre IT-Abteilung beim Lesen hinzuzuziehen. Bei Fragen oder Anfragen kontaktieren Sie uns bitte unter support@azumuta.com – wir helfen Ihnen gerne weiter.
Was ist Simple Entry Integration?
Ein häufiger Anwendungsfall der Simple Entry Integration ist die automatische Navigation zu Produktaufträgen. Ein Bediener kann den Barcode eines Produktauftrags scannen, und sein Bildschirm wird automatisch zu diesem Produktauftrag weitergeleitet, sodass er sofort mit der Arbeit an diesem Auftrag auf seinem Gerät beginnen kann.
Um dies zu ermöglichen, haben wir eine generische Simple Entry Integration erstellt, die im Bereich Integrations Ihrer Unternehmenseinstellungen verfügbar ist. So gelangen Sie zu diesem Bereich.
- Klicken Sie auf Settings unter Management.
- Klicken Sie auf Integrations unter Integrations.
Die vorausgefüllte URL /api/integrations/generic/v1/getOrderByBarcode ist eine generische Implementierung des Simple-Entry-Prozesses. Diese Konfiguration erlaubt einen einfachen Ablauf, bei dem das Scannen bzw. Eingeben einer Produktauftrag-Identifikation einen bestehenden Produktauftrag öffnet.
Hinweis: Dies funktioniert nur, wenn der Produktauftrag bereits existiert und der gescannte Code exakt mit der Produktidentifier in Azumuta übereinstimmt.
Wenn Sie erweiterte Funktionalität benötigen, z. B. das automatische Anlegen eines noch nicht vorhandenen Produktauftrags, lesen Sie bitte diesen Abschnitt.
Nachdem Sie eine Simple Entry Integration in Ihren Unternehmenseinstellungen eingerichtet haben, aktualisieren Sie die Geräteeinstellungen, auf denen Sie sie verwenden möchten. Navigieren Sie zur Product orders-Registerkarte und prüfen Sie sorgfältig die unten hervorgehobenen Einstellungen:
Eigene Simple Entry Integration erstellen
Wenn Sie diesen Prozess mit Ihrer eigenen Business-Logik erweitern möchten, können Sie eine benutzerdefinierte Integration erstellen.
Wenn ein Gerät so konfiguriert ist, Simple Entry zu verwenden, sendet es eine Anfrage an die in dem Feld simpleEntryEndpoint angegebene URL. Das Config-Feld kann leer gelassen werden.
Nachdem auf dem konfigurierten Gerät ein Barcode gescannt wurde, sendet unser Dienst eine GET-Anfrage an die im Feld simpleEntryEndpoint angegebene URL.
Die Anfrage enthält einen Query-Parameter namens barcode, der den gescannten Code bzw. die Eingabe auf dem Gerät repräsentiert.
Hinweis: Der Barcode wird URL-codiert sein.
Authentifizierung
Die Einstellung Authentication in der Integration legt fest, wie sich Azumuta gegenüber Ihrem Endpoint identifiziert. Sie bietet die gleichen Optionen wie ein Procedure Check Webhook.
- Legacy (API key of the calling device) – die Standardeinstellung für Integrationen, die vor Einführung dieser Option erstellt wurden. Azumuta sendet den API-Schlüssel des Geräts, das den Barcode gescannt hat, in einem
x-api-key-Header. Dieser Schlüssel authentifiziert das Gerät gegenüber der Azumuta REST API, sodass Ihr Endpoint damit in Azumuta zurückrufen kann, jedoch authentifiziert er Azumuta nicht gegenüber Ihnen. Verwenden Sie für neue Integrationen vorzugsweise eine der unten stehenden Optionen. - None – es werden keine Anmeldeinformationen gesendet.
- Header – ein von Ihnen gewählter Header, der entweder einen von Ihnen eingegebenen Wert oder den API-Schlüssel eines API-Geräts enthält, das Sie auswählen. Der Header-Name lautet standardmäßig
X-API-Key. - Basic – ein Benutzername und Passwort, gesendet als
Authorization: Basic-Header. - OAuth client credentials – Azumuta fordert mit Client-ID und Client-Secret ein Token von Ihrer Token-URL an und sendet es dann als
Authorization: Bearer-Header. Die Token-URL muss https verwenden.
Die Auswahl einer anderen Option als Legacy ersetzt den x-api-key-Header, anstatt ihn hinzuzufügen. Das scannende Gerät wird weiterhin über die Query-Parameter deviceId und deviceName identifiziert.
Geheimnisse, die Sie eingeben (z. B. ein Header-Wert, ein Passwort, ein Client-Secret), werden verschlüsselt gespeichert und niemals an den Browser zurückgesendet. Beim erneuten Öffnen der Integration ist das Feld leer; lassen Sie es leer, um das gespeicherte Geheimnis beizubehalten. Das Ändern der Endpoint-URL (bzw. bei OAuth der Token-URL) löscht das gespeicherte Geheimnis, sodass Sie es erneut eingeben müssen.
Request-Beispiel
Request:
url:
Der obige Header ist die Legacy-Standardeinstellung. Bei jeder anderen Authentication-Option wird stattdessen die von Ihnen konfigurierte Anmeldeinformation gesendet.
Nach der Verarbeitung Ihrer individuellen Logik sollte die Integration mit einem JSON-Objekt antworten, das das Feld identifier enthält. Der Content-Type der Anfrage sollte application/json sein.
Response-Beispiel
{ identifier: „
Produktauftrag automatisch erstellen
Eine häufige Kundenanfrage ist die Möglichkeit, für den gescannten Code automatisch einen Produktauftrag anzulegen (falls dieser noch nicht existiert).
Dies lässt sich leicht mit einem einzigen Aufruf der Products Create REST API erreichen. Öffnen Sie Help (das Fragezeichen oben rechts) → API docs, und öffnen Sie dann den Products Create-Endpunkt. Authentifizieren Sie sich mit einem API-Schlüssel von einem API-Gerät. Mehr zum Zugriff auf die Dokumentation: Azumutas REST API.
Sie können eine POST-Anfrage an den Create-Product-Endpunkt mit den folgenden Parametern stellen:
returnExisting: true — Dadurch wird kein neuer Produktauftrag erstellt; stattdessen wird im Falle eines bereits vorhandenen Produktauftrags der bestehende Auftrag zurückgegeben.
activate: true — Aktiviert den Produktauftrag nach der Erstellung automatisch. Die Aktivierung eines Produktauftrags macht ihn in der Bedieneroberfläche sichtbar. Diese Aktion stellt sicher, dass die zugehörigen Arbeitsanweisungen auf ihre jeweils neuesten freigegebenen Versionen gesperrt werden.