Intégration de saisie simple
Note : Cet article est technique, nous vous recommandons donc d'y faire intervenir une personne possédant les compétences techniques appropriées. Si vous avez des questions, contactez-nous à support@azumuta.com.
Qu'est-ce que Simple Entry Integration ?
Un cas d'utilisation courant de la simple entry integration est la navigation automatique vers les ordres de production. Un opérateur peut scanner le code-barres d'un ordre de production, et son écran sera automatiquement redirigé vers cet ordre de production, afin qu'il puisse immédiatement commencer à travailler dessus 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. Pour 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 de production ouvrira un ordre de production existant.
Remarque : Cela ne fonctionne que si l'ordre de production 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 de production qui n'existe pas encore, veuillez consulter this section.
Après avoir configuré une Simple Entry Integration dans les paramètres de votre entreprise, mettez à jour les paramètres de l'appareil où vous souhaitez l'utiliser. Rendez-vous dans l'onglet Product orders, et examinez 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 config peut rester 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 code-barres sera URL-encodé
Authentication
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 vérification de procédure.
- Legacy (API key of the calling device) - le comportement par défaut pour les intégrations créées avant l'existence de ce paramètre. Azumuta envoie la clé API de l'appareil ayant scanné le code-barres dans un en-tête
x-api-key. Cette clé authentifie l'appareil auprès de l'Azumuta REST API, de sorte que votre endpoint peut effectuer des appels de retour vers 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 intégration. - 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 jeton (token) depuis votre URL de token avec un client ID et un client secret, puis l'envoie sous la forme d'un en-tête
Authorization: Bearer. L'URL de token doit utiliser https.
Choisir une option autre que Legacy remplace l'en-tête x-api-key au lieu de l'ajouter. L'appareil de scan est toujours identifié via les paramètres de requête deviceId et deviceName.
Les secrets que vous saisissez (valeur d'en-tête, mot de passe, client secret) sont chiffrés avant stockage 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
Request:
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 le traitement de votre logique personnalisée, l'intégration devrait répondre par un objet JSON contenant le champ identifier. Le Content-type de la requête doit être application/json.
Exemple de réponse
{ identifier: “
Créer automatiquement un ordre de production
Une demande de fonctionnalité courante que nous recevons souvent de la part des clients est la possibilité de créer automatiquement un ordre de production pour le code scanné (si l'ordre de production n'existe pas encore).
Cela peut être réalisé facilement en effectuant un seul appel au REST API Products Create. Ouvrez Help (le point d'interrogation en haut à droite) → API docs, puis ouvrez l'endpoint Products Create. Authentifiez-vous avec une clé API provenant d'un Api Device. Plus d'informations sur l'accès à la documentation : Azumuta’s REST API.
Vous pouvez effectuer une requête POST vers l'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 de production existe déjà.
activate: true — Active automatiquement l'ordre de production lors de sa création. L'activation d'un ordre de production 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.