Intégration d'entrée simple
Remarque : Cet article est très technique. Nous vous recommandons donc d'impliquer votre service informatique lors de sa lecture. Pour toute question ou demande, veuillez nous contacter via support@azumuta.com. Nous serons ravis de vous aider.
Qu'est-ce que Simple Entry Integration ?
Un cas d'utilisation courant de la simple entry integration est la navigation automatique vers des ordres produits. Un opérateur peut scanner le code-barres d'un ordre produit, et son écran sera automatiquement redirigé vers cet ordre produit, afin qu'il puisse commencer immédiatement à travailler sur cet ordre depuis son appareil.
Pour activer cela, nous avons créé une Simple Entry Integration générique, disponible dans la section Integrations des paramètres de votre entreprise. Voici comment accéder à cette section.
- Cliquez sur Settings sous Management.
- Cliquez sur Integrations sous Integrations.
L'URL préremplie /api/integrations/generic/v1/getOrderByBarcode est une implémentation générique du processus de simple entry. Cette configuration permet un flux simple où le scan et la saisie d'un identifiant d'ordre produit ouvrira un ordre produit existant.
Remarque : Cela ne fonctionne que si l'ordre produit existe déjà et que le code scanné correspond exactement à l'identifiant du produit dans Azumuta.
Si vous avez besoin de fonctionnalités plus avancées, comme la création automatique d'un ordre produit qui n'existe pas encore, veuillez consulter cette section.
Après avoir configuré une Simple Entry Integration dans les paramètres de votre entreprise, mettez à jour les paramètres de l'appareil sur lequel vous souhaitez l'utiliser. Rendez-vous dans l'onglet Product orders, et vérifiez attentivement les paramètres mis en évidence ci-dessous :
Créer une Simple Entry Integration personnalisée
Si vous souhaitez étendre ce processus avec votre propre logique métier, vous pouvez créer une integration personnalisée.
Lorsqu'un appareil est configuré pour utiliser la simple entry, il enverra une requête à l'URL spécifiée dans le champ simpleEntryEndpoint. Le champ de configuration peut être laissé vide.
Après le scan d'un code-barres sur l'appareil configuré, notre service enverra une requête GET à l'URL fournie dans le champ simpleEntryEndpoint.
La requête inclura un paramètre de requête nommé barcode , qui représente le code scanné ou la saisie sur l'appareil.
Remarque : Le barcode sera encodé dans l'URL
Authentification
Le paramètre Authentication de l'intégration détermine comment Azumuta s'identifie auprès de votre endpoint. Il offre les mêmes options qu'un webhook de contrôle de procédure.
- Legacy (API key of the calling device) - 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 auprès de l'API REST d'Azumuta, de sorte que votre endpoint peut rappeler Azumuta avec cette clé, mais elle n'authentifie pas Azumuta auprès de vous. Préférez l'une des options ci-dessous pour une nouvelle integration. - None - aucune information d'identification n'est envoyée.
- Header - un en-tête de votre choix, contenant soit une valeur que vous saisissez, soit la clé API d'un API device que vous sélectionnez. Le nom de l'en-tête par défaut est
X-API-Key. - Basic - un nom d'utilisateur et un mot de passe, envoyés sous la forme d'un en-tête
Authorization: Basic. - OAuth client credentials - Azumuta demande un token à votre token URL avec un client ID et un client secret, puis l'envoie sous la forme d'un en-tête
Authorization: Bearer. L'URL du token doit utiliser https.
Le choix d'une option autre que Legacy remplace l'en-tête x-api-key au lieu de l'ajouter. L'appareil ayant scanné est toujours identifié via les paramètres de requête deviceId et deviceName.
Les secrets que vous saisissez (une valeur d'en-tête, un mot de passe, un client secret) 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 de l'endpoint (ou, pour OAuth, l'URL du token) efface le secret stocké, vous devrez donc le saisir à nouveau.
Exemple de requête
Requête :
url:
L'en-tête ci-dessus est le comportement Legacy par défaut. Avec toute autre option d'Authentication, l'identifiant que vous avez configuré est envoyé à la place.
Après traitement de votre logique personnalisée, l'intégration doit répondre avec un objet JSON contenant le champ identifier. Le content-type sur la requête doit être application/json.
Exemple de réponse
{ identifier: “
Créer automatiquement un ordre produit
Une demande fréquente de nos clients est la possibilité de créer automatiquement un ordre produit pour le code scanné (si l'ordre produit n'existait pas encore).
Cela peut être réalisé facilement en appelant l'API REST Products Create une seule fois. Ouvrez Help (le point d'interrogation en haut à droite) → API docs, puis ouvrez le endpoint Products Create. Authentifiez-vous avec une clé API d'un Api Device. Plus d'informations pour accéder aux docs : Azumuta’s REST API.
Vous pouvez effectuer une requête POST vers le endpoint de création de produit en utilisant les paramètres suivants :
returnExisting: true — Cela ne créera pas un nouveau produit mais renverra le produit existant dans le cas où l'ordre produit existe déjà.
activate: true — Active automatiquement l'ordre produit lors de sa création. L'activation d'un ordre produit le rend visible dans l'interface opérateur. Cette action garantit que les instructions de travail associées sont verrouillées sur leurs dernières versions approuvées.