Intégration d'entrée simple
Remarque : Il s'agit d'un article hautement technique. Nous vous recommandons donc d'impliquer votre service informatique lors de la lecture. Pour toute question ou demande, contactez-nous via support@azumuta.com - nous serons heureux de vous aider.
What Is 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 commencer immédiatement à travailler dessus depuis son appareil.
Pour activer cela, nous avons créé une Simple Entry Integration générique, disponible dans la section Intégrations des paramètres de votre 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ù le scan et la saisie d'un identifiant d'ordre de production ouvrent 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 de l'ordre dans Azumuta.
Si vous avez besoin d'une fonctionnalité plus avancée, comme la création automatique d'un ordre de production qui n'existe pas encore, référez-vous à 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 où vous souhaitez l'utiliser. Rendez-vous dans l'onglet Product orders et passez en revue avec attention les paramètres mis en évidence ci-dessous :
Create a custom simple entry integration
Si vous souhaitez étendre ce processus avec votre propre logique métier, vous pouvez créer une intégration 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
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 contrôle de procédure.
- Legacy (API key of the calling device) - le réglage par défaut pour les intégrations créées avant l'apparition de cette option. 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 appeler Azumuta en retour avec cette clé, mais elle n'authentifie pas Azumuta auprès de vous. Préférez une des options ci-dessous pour une nouvelle intégration. - None - aucune crédential 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 à votre URL de token avec un client ID et un client secret, puis l'envoie dans un en-tête
Authorization: Bearer. L'URL du 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 ressaisir.
Request Example
Request:
url:
L'en-tête ci-dessus est le comportement Legacy par défaut. Avec toute autre option d'Authentication, la crédential que vous avez configurée est envoyée à la place.
Après le traitement de votre logique personnalisée, l'intégration doit répondre avec un objet JSON contenant le champ identifier. Le Content-type de la requête doit être application/json.
Response Example
{ identifier: “
Create a product order automatically
Une demande fréquente que nous recevons 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 à l'API REST Products Create. 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. Pour plus d'informations sur l'accès à la documentation : Azumuta’s REST API.
Vous pouvez faire une requête POST vers le endpoint de création de produit en utilisant les paramètres suivants :
returnExisting: true — Cela n'entraînera pas la création d'un nouveau produit mais renverra le produit existant si 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.