Intégration Simple Entry – Azumuta

Remarque : Cet article est hautement technique. Par conséquent, nous vous recommandons d'impliquer votre département informatique lors de sa lecture. Si vous avez des questions ou des demandes, veuillez contactez-nous via support@azumuta.com - nous serions heureux de vous aider.

Qu'est-ce que l'intégration Simple Entry ?

Un cas d'usage courant de l'intégration Simple Entry est la Navigation automatique vers les commandes de produits. Un opérateur peut scanner le code-barres d'une commande de produit, et son écran sera automatiquement redirigé vers cette commande de produit, afin qu'il puisse immédiatement commencer à travailler sur cette commande de produit sur son appareil.

Pour activer cela, nous avons créé une Intégration Simple Entry générique, disponible dans la section Intégrations de vos paramètres d'entreprise. Voici comment accéder à cette section.

Cliquez sur Paramètres sous Gestion.
Cliquez sur Intégrations sous Intégrations.

L'URL préremplie /api/integrations/generic/v1/getOrderByBarcode est une implémentation générique du processus Simple Entry. Cette configuration permet un flux simple où scanner et entrer un identifiant de commande de produit ouvrira une commande de produit existante.

Remarque : Cela ne fonctionne que si la commande de produit existe déjà et si le code scanné correspond exactement à l'identifiant du produit dans Azumuta.

Si vous avez besoin de fonctionnalités plus avancées, comme créer automatiquement une commande de produit qui n'existait pas encore, veuillez consulter cette section.

Après avoir configuré une Intégration Simple Entry dans vos paramètres d'entreprise, mettez à jour les paramètres de l'appareil où vous souhaitez l'utiliser. Accédez à l'onglet Commandes de produits, et examinez attentivement les paramètres mis en évidence ci-dessous :

Créer une intégration Simple Entry personnalisée

Si vous souhaitez étendre ce processus avec votre propre logique métier personnalisée, vous pouvez créer une intégration personnalisée.

Quand un appareil est configuré pour utiliser Simple Entry, il enverra une demande à l'URL spécifiée dans le champ simpleEntryEndpoint. Le champ de configuration peut être laissé vide.

Après avoir scanné un code-barres sur l'appareil configuré, notre service enverra une demande GET à l'URL fournie dans le champ simpleEntryEndpoint.

La demande inclura un paramètre de requête nommé barcode, qui représente le code scanné ou l'entrée sur l'appareil.

Remarque : Le code-barres sera codé en URL

Authentification

Le paramètre Authentification sur l'intégration détermine comment Azumuta s'identifie à votre point de terminaison. Il offre les mêmes options qu'un webhook de vérification de procédure.

Hérité (clé API de l'appareil appelant) - la valeur par défaut pour les intégrations créées avant l'existence de ce paramètre. Azumuta envoie la clé API de l'appareil qui a scanné le code-barres dans un en-tête x-api-key. Cette clé authentifie l'appareil par rapport à l'API REST Azumuta, afin que votre point de terminaison puisse rappeler Azumuta avec elle, mais elle n'authentifie pas Azumuta auprès de vous. Préférez l'une des options ci-dessous pour une nouvelle intégration.
Aucun - aucune information d'identification n'est envoyée.
En-tête - un en-tête de votre choix, contenant soit une valeur que vous entrez, soit la clé API d'un Appareil API que vous sélectionnez. Le nom de l'en-tête est par défaut X-API-Key.
Basic - un nom d'utilisateur et un mot de passe, envoyés en tant qu'en-tête Authorization: Basic.
Identifiants client OAuth - Azumuta demande un token à votre URL de token avec un ID client et un secret client, puis l'envoie en tant qu'en-tête Authorization: Bearer. L'URL du token doit utiliser https.

Choisir autre chose que Hérité remplace l'en-tête x-api-key plutôt que de l'ajouter. L'appareil de numérisation est toujours identifié via les paramètres de requête deviceId et deviceName.

Les secrets que vous entrez (une valeur d'en-tête, un mot de passe, un secret client) sont chiffrés avant d'être stockés et ne sont jamais renvoyés au navigateur. Lorsque vous rouvrez l'intégration, le champ est vide ; laissez-le vide pour conserver le secret stocké. Modifier l'URL du point de terminaison (ou, pour OAuth, l'URL du token) efface le secret stocké, vous devez donc le saisir à nouveau.

Exemple de demande

Demande : url: <simpleEntryEndpoint>?barcode=<barcode>&deviceId=<deviceId>&deviceName=<deviceName> headers: { x-api-key: <Azumuta REST API key> }

L'en-tête ci-dessus est la valeur par défaut Hérité. Avec toute autre option d'Authentification, l'information d'identification que vous avez configurée est envoyée à sa place.

Après avoir traité votre logique personnalisée, l'intégration doit répondre avec un objet JSON contenant le champ identifier. Le Content-type sur la demande doit être application/json.

Exemple de réponse

{ identifier: "<identifier>" }

Créer une commande de produit automatiquement

Une demande de fonctionnalité courante que nous recevons souvent de nos clients est la possibilité de créer automatiquement une commande de produit pour le code scanné (si la commande de produit n'existait pas encore).

Ceci peut être facilement réalisé en utilisant un seul appel à l'API REST Créer un produit. Ouvrez Aide (le point d'interrogation dans le coin supérieur droit) → Docs API, puis ouvrez le point de terminaison Créer un produit. Authentifiez-vous avec une clé API d'un Appareil API. Plus d'informations sur l'accès aux docs : API REST d'Azumuta.

Vous pouvez faire une demande POST au point de terminaison de création de produit en utilisant les paramètres suivants :

returnExisting: true — Cela ne créera pas un nouveau produit mais retournera le produit existant au cas où la commande de produit existerait déjà.
activate: true — Activer automatiquement la commande de produit lors de la création. Activer une commande de produit la rend visible dans l'Interface opérateur. Cette action garantit que les instructions de travail associées sont verrouillées à leurs Versions approuvées les plus récentes.