Points de terminaison des transactions et des journaux
Votre guide d'intégration V5 !
Introduction
En plus des points de terminaison d'exportation vus jusqu'à présent dans nos guides d'intégration V5, l'API V5 propose également plusieurs points de terminaison transactionnels qui peuvent être utilisés pour renvoyer descripteurs d'événements système/logs vers un ERP externe.
Table des Matières
1. Points de terminaison du journal système
Les points de terminaison génériques peuvent être utilisés pour renvoyer un large éventail de descripteurs à travers un certain nombre de différents modules.
Ces points de terminaison renverront des données plus complexes que les points de terminaison transactionnels/génériques et contiendront souvent plusieurs ensembles de données imbriquées relatives aux événements de descripteur. Bien que cela soit utile dans le sens où les données correctes seront renvoyées, ces points de terminaison devront souvent être filtrés pour utiliser au mieux les données renvoyées.
Nous pouvons voir ce que c'est pour l'API V5 ci-dessous :
1.1. Journaux système
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/system_logs
Ce point de terminaison fournira un fichier de retour JSON qui intègre tous événement système descripteurs et les données les concernant. Si nous atteignons ce point final, nous obtiendrons un retour qui ressemble à ceci :
Nous pouvons donc voir ici que bien que nous recevions le descripteur « CONSOMMÉ » vers le bas de cette image pour certains fils de safran utilisés pour un lot, nous recevons également de nombreuses données imbriquées supplémentaires, telles qu'un retour de classe complet pour le fournisseur et emplacement que nous pouvons voir ici.
Des filtres peuvent être configurés dans votre ERP pour sélectionner de manière sélective les données que vous souhaitez voir.
Ce fichier exemple peut être téléchargé ici.
Utile pour:
1.2. Journal du système
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/system_log/{id}
Ce point de terminaison fournira un fichier de retour JSON structuré de la même manière que l'exportation « Journaux système » ci-dessus, mais nous pouvons ici spécifier un numéro d'ID de journal individuel pour lequel renvoyer les informations associées. Ceci est utile si nous voulons nous concentrer sur un événement spécifique ou descripteur.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
1.3. Journaux du système de réglage
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/adjustment_logs
Ce point de terminaison renverra un fichier JSON avec une liste d'événements du journal système avec le « AJUSTEMENT » descripteur, réduisant le retour de ce que nous avons vu ci-dessus pour les « Journaux système » aux entrées qui contiennent uniquement ce descripteur. Cela permet de fournir des données plus pertinentes que l’ERP pourra traiter en fonction de vos besoins.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
1.4. Journaux système consommés/produits :
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/system_logs_cp
Ce point de terminaison renverra un fichier JSON avec une liste d'événements de journal système avec « CONSUMED » ou « PRODUCED » descripteur, limitant le retour de ce que nous avons vu ci-dessus pour les « Journaux système » aux entrées contenant ces descripteurs. Ces journaux concernent le processus principal de traitement par lots, en particulier la réduction et la production des stocks. Cela permet de fournir des données plus pertinentes que l’ERP pourra traiter en fonction de vos besoins.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
1.5. Journaux système non consommés/produits :
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/system_logs_noncp
Ce point de terminaison agit effectivement comme l'inverse du point de terminaison « Journaux système consommés/produits » ci-dessus et renverra un fichier JSON qui répertorie les journaux système avec tout sauf « CONSOMMÉ » ou « PRODUIT » descripteurs.
Utile pour:
1.6. Journaux d'utilisation
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs
Ce point de terminaison renverra un fichier JSON avec une liste d'événements de journal système relatifs au traitement par lots, limitant le retour de ce que nous avons vu ci-dessus pour les « Journaux système » aux entrées contenant descripteurs tels que « COLLATED », « BATCH SUSPENDED », etc. (ainsi que « CONSOMMÉ » et « PRODUIT »). Cela permet de fournir des données plus pertinentes que l’ERP pourra traiter en fonction de vos besoins.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
1.7. Journaux d'utilisation (date de filtre)
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}
Ce point de terminaison renvoie les mêmes informations que les « Journaux d'utilisation » ci-dessus, mais permet à un filtre à partir de la date (horodatage de l'époque) d'affiner les résultats si vous le souhaitez.
Utile pour:
1.8. Journaux de travaux
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/job_logs
Ce point de terminaison fournira un fichier de retour JSON qui intègre le système descripteurs liés à la production d’emplois.
Un exemple de fichier de ce type peut être téléchargé ici.
Utile pour:
2. Points de terminaison transactionnels/génériques
Les points de terminaison transactionnels sont utilisés pour renvoyer des informations simplifiées sur descripteur des événements qui concernent plus spécifiquement la façon dont les différents modules gèrent les niveaux de stock. Contrairement aux points de terminaison génériques que nous avons vus ci-dessus et qui fournissent une variété de données imbriquées, ces points de terminaison fournissent des informations simplifiées sans données imbriquées.
Nous pouvons voir à quoi cela ressemblerait dans nos exemples ci-dessous :
2.1. Opérations d'ajustement
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/transactions/adjustments
Ce point de terminaison peut être utilisé pour fournir une liste des transactions d'ajustement survenues dans le système. En utilisant ce point de terminaison, nous obtiendrons une entrée renvoyée chaque fois que la quantité d'un lot est modifiée (ou ajustée) à l'aide de Control Center ou de WMS. Cela pourrait être dû à des dommages ou à des produits périmés qui doivent être retirés du système.
Un exemple d'exportation de ce type pourrait ressembler à ceci :
Comme nous pouvons le voir ici, il s'agit d'une seule entrée pour un « AJUSTEMENT » descripteur événement et ne contient aucune des données imbriquées potentiellement superflues que nous avons vues avec le point de terminaison générique.
Un exemple de fichier de ce type peut être téléchargé ici.
Utile pour:
2.2. Transactions de consommation par lots
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
Un export de transactions de consommation par lots fournira un fichier JSON simplifié qui fournit la consommation et la production descripteur données pertinentes pour un lot spécifique terminé qui a été traité par le système.
En utilisant ce point final, nous obtiendrons un retour indiquant tous les produits qui ont été consommés par lots, ainsi que la quantité de lots eux-mêmes qui ont ensuite été produits.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
2.3. Transactions de consommation par lots (date de filtre)
Point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}
Ce point de terminaison renvoie les mêmes informations que « Consommation par lots » ci-dessus, mais permet à un filtre à partir de la date (horodatage de l'époque) d'affiner les résultats si vous le souhaitez.
Utile pour:
2.4. Transactions de bons de commande
Exporter le point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/transactions/purchase
Une exportation de transactions d'achat à partir de ce point de terminaison fournira un fichier JSON simplifié qui fournit des données de réception pertinentes pour les bons de commande, notamment descripteurs de système tel que « REÇU ».
Le point de terminaison fournit uniquement ces données pour les commandes terminées qui n'ont pas été marquées comme exportées.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
2.5. Transactions de commande client
Exporter le point de terminaison/URI –
http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}
Une exportation de transactions de vente à partir de ce point de terminaison fournira un fichier JSON simplifié qui fournit des données d'allocation/prélèvement/expédition pertinentes pour les commandes clients. L'utilisation de ce point de terminaison renverra les données relatives à tous les articles vendus via les commandes clients et descripteurs tels que « CHOISI » et « EXPÉDIÉ ».
Le point de terminaison peut fournir ces données pour les commandes terminées (vrai) ou pour toutes les commandes (faux), à condition que ces commandes n'aient pas déjà été marquées comme exportées.
Un exemple de ce type de fichier peut être téléchargé ici.
Utile pour:
