Einfache Eingabe-Integration
Hinweis: Dieser Artikel ist technisch, daher empfehlen wir, eine Person mit entsprechender technischer Expertise hinzuzuziehen. Bei Fragen kontaktieren Sie uns unter support@azumuta.com.
Was ist Simple Entry Integration?
Ein gängiger Anwendungsfall für 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. Um zu diesem Bereich zu gelangen:
- 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 Einrichtung ermöglicht einen einfachen Ablauf, bei dem das Scannen beziehungsweise Eingeben einer Produktauftragskennung einen bestehenden Produktauftrag öffnet.
Hinweis: Dies funktioniert nur, wenn der Produktauftrag bereits existiert und der gescannte Code genau mit der Produktauftragskennung in Azumuta übereinstimmt.
Wenn Sie erweiterte Funktionen benötigen, z. B. das automatische Anlegen eines noch nicht existierenden Produktauftrags, lesen Sie bitte diesen Abschnitt.
Nachdem Sie eine Simple Entry Integration in Ihren Unternehmenseinstellungen eingerichtet haben, aktualisieren Sie die Geräteeinstellungen, an denen Sie sie verwenden möchten. Navigieren Sie zum Product orders tab und prüfen Sie sorgfältig die unten hervorgehobenen Einstellungen:
Erstellen einer benutzerdefinierten Simple Entry Integration
Wenn Sie diesen Prozess mit eigener Geschäftslogik erweitern möchten, können Sie eine benutzerdefinierte Integration erstellen.
Wenn ein Gerät für die Verwendung von Simple Entry konfiguriert ist, sendet es eine Anfrage an die in dem Feld simpleEntryEndpoint angegebene URL. Das config-Feld kann leer gelassen werden.
Nach dem Scannen eines Barcodes auf dem konfigurierten Gerät sendet unser Dienst eine GET-Anfrage an die im Feld simpleEntryEndpoint angegebene URL.
Die Anfrage enthält einen Query-Parameter mit dem Namen barcode, der den gescannten Code oder die Eingabe auf dem Gerät darstellt.
Hinweis: Der barcode wird URL-kodiert
Authentifizierung
Die Einstellung Authentication für die Integration legt fest, wie sich Azumuta gegenüber Ihrem Endpunkt identifiziert. Sie bietet die gleichen Optionen wie ein procedure check webhook.
- Legacy (API key of the calling device) - der Standard für Integrationen, die vor dieser Einstellung 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 Endpunkt damit Rückrufe an Azumuta vornehmen kann, authentifiziert jedoch nicht Azumuta gegenüber Ihnen. Verwenden Sie für neue Integrationen vorzugsweise eine der folgenden Optionen. - None - es werden keine Zugangsdaten gesendet.
- Header - ein Header Ihrer Wahl, der entweder einen von Ihnen eingegebenen Wert oder den API-Schlüssel eines Api Device enthält. Der Header-Name ist standardmäßig
X-API-Key. - Basic - ein Benutzername und Passwort, gesendet als
Authorization: Basic-Header. - OAuth client credentials - Azumuta fordert ein Token von Ihrer Token-URL mit einer Client-ID und einem Client-Secret an und sendet es dann als
Authorization: Bearer-Header. Die Token-URL muss https verwenden.
Die Wahl einer anderen Option als Legacy ersetzt den x-api-key-Header, anstatt ihn zu ergänzen. Das scannende Gerät wird weiterhin über die Query-Parameter deviceId und deviceName identifiziert.
Geheimnisse, die Sie eingeben (ein Header-Wert, ein Passwort, ein Client-Secret), werden verschlüsselt gespeichert und niemals an den Browser zurückgesendet. Wenn Sie die Integration erneut öffnen, ist das Feld leer; lassen Sie es leer, um das gespeicherte Geheimnis beizubehalten. Eine Änderung der Endpoint-URL (bzw. bei OAuth der Token-URL) löscht das gespeicherte Geheimnis, sodass Sie es erneut eingeben müssen.
Beispielanfrage
Request:
url:
Der obenstehende Header ist der Legacy-Standard. Bei jeder anderen Authentication-Option wird stattdessen die von Ihnen konfigurierte Zugangsinformation gesendet.
Nach der Verarbeitung Ihrer benutzerdefinierten Logik sollte die Integration mit einem JSON-Objekt antworten, das das Feld identifier enthält. Der Content-Type der Antwort sollte application/json sein.
Antwortbeispiel
{ identifier: “
Produktauftrag automatisch erstellen
Eine häufige Anforderung unserer Kunden ist die Möglichkeit, automatisch einen Produktauftrag für den gescannten Code zu erstellen (falls der Produktauftrag noch nicht existiert).
Dies lässt sich einfach mit einem einzigen Aufruf der Products Create REST API realisieren. Öffnen Sie Help (das Fragezeichen oben rechts) → API docs, und öffnen Sie den Products Create-Endpunkt. Authentifizieren Sie sich mit einem API-Schlüssel von einem Api Device. Mehr zum Zugriff auf die Dokumentation: Azumuta’s REST API.
Sie können eine POST-Anfrage an den Create-Product-Endpunkt mit den folgenden Parametern stellen:
returnExisting: true — Dadurch wird kein neues Produkt erstellt; stattdessen wird das bestehende Produkt zurückgegeben, falls der Produktauftrag bereits existiert.
activate: true — Aktiviert den Produktauftrag bei der Erstellung automatisch. Durch die Aktivierung wird der Produktauftrag in der Bedieneroberfläche sichtbar. Diese Aktion stellt sicher, dass die zugehörigen Arbeitsanweisungen auf ihre zuletzt freigegebenen Versionen gesperrt werden.