REST API Exportation des images des aménagements
Cette source est utilisée pour extraire des données des photos d'aménagements depuis Quant. Le format de sortie est actuellement JSON.
L'exportation n'est accessible qu'à l'utilisateur Quant ayant le rôle Robot et pour lequel cette option est activée dans les paramètres. Sinon, l'exportation ne sera pas effectuée et l'attribut de statut dans la réponse contiendra un message d'erreur :
HTTP 401 {"token":"<TOKEN>","status":"User is not authorized for this Resource."}
- Requête
Paramètre | Valeur |
URL | /equipmentImagesDataExport/json |
Debug | Ajoutez à l'URL ?debug=true pour afficher aussi les avertissements. Sinon, seules les messages d'erreurs sont affichés. |
Header | Accept: application/json |
Header | Authorization: Bearer <TOKEN> Le TOKEN s'obtient via /authenticate (voir le manuel REST API Introduction et connexion). |
Mèthode | GET |
- Attributs
Les paramètres d'exportation sont également définis dans les paramètres de l'utilisateur (voir illustration ci-dessus).
Attribut | Description | Type |
Activé | Spécifie si la tâche automatique est active et peut recevoir des données. | oui/non |
Titre | Nom personnalisé de la tâche automatique. | texte |
Description | Description personnalisée du rôle de la tâche automatique. | texte formaté |
Remarques | Notes. | texte long |
Exporter les éléments plus récents que | Date à partir de laquelle les images seront exportées. Si renseignée, seules les images téléchargées après cette date seront exportées. | date |
Inclure les annotations | Si activé, l'ID de l'image exportée inclura les ajustements personnalisés. Sinon, l'ID de l'image d'origine est exporté. | oui/non |
Largeur maximale de l'image du planogramme (px) | Largeur maximale de l'image du planogramme à télécharger, en pixels. | positive integer |
Hauteur maximale de l'image du planogramme (px) | Hauteur maximale de l'image du planogramme à télécharger, en pixels. | positive integer |
Format de date | Format de date, par ex. 31.12.19 | sélection |
- Réponse
Paramètre | Valeur |
Body | {"token":"<TOKEN>","status":"<STATUS>,"Total Lines":<LINE_COUNT>,"Ignored Pictures":<IGNORED>," Records“:<RECORDS>,“Errors“:[ERRORS], “Warnings“:[WARNINGS]“} |
Attribut | Description | Type |
Token | Jeton d'authentification de l'utilisateur. | texte |
Status | SUCCES si tout a été exporté correctement, PARTIAL_SUCCESS si l'exportation a réussi, mais que certains enregistrements n'ont pas été exportés, et FAILURE si une erreur inattendue a interrompu prématurément l'exportation. | texte |
Total Lines | Nombre d'enregistrements d'entrée. | numéro |
Ignored Pictures | Nombre d'images qui n'ont pas été exportées car non attribuées à un aménagement. | numéro |
Records | Liste des enregistrements exportés. | Tableau JSON |
Errors | Tableau d'objets JSON décrivant les erreurs. Non inclus si vide. | Tableau JSON |
Warnings | Tableau d'objets JSON décrivant l'avertissement (uniquement si la requête contenait le paramètre debug = true). Non inclus si vide. | Tableau JSON |
- Journal d'exécution
Dans Quant, en plus des paramètres d'exportation sur le robot, vous pouvez consulter l'historique des exportations individuelles, avec les statistiques, erreurs, avertissements et informations générales.
Si vous sélectionnez un enregistrement spécifique, vous pouvez afficher ses détails en cliquant sur le bouton Afficher les éléments. Après avoir marqué les éléments sélectionnés, cliquez sur Télécharger les fichiers. Ces fichiers contiennent les données d'entrée pour l'exportation donnée.
Requête
curl -H "accept: application/json" -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/equipmentImagesDataExport/json?debug=true
Cet exemple montre comment lancer l'exportation après avoir obtenu un TOKEN via l'identification.
Réponse
{"token":"i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX","status":"SUCCESS","Total Lines":2,"Ignored Pictures":1,"Records": [{"EquipmentID":"b098ed39-f826-4827-aafa-acc85ebf6ee6","ID":"735076","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"105","Implemented Planogram Id":"96444","Title":"","Description":""},{"EquipmentID":"2d212db0-0efd-4dfd-90a5-eac838d026d3","ID":"735075","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"104","Implemented Planogram Id":"1578","Title":"","Description":""}], "Warnings":["Equipment Photo with ID "425742" has no equipment assigned."]}
Cette réponse signifie une exportation réussie avec un avertissement. Les détails et les statistiques peuvent ensuite être consultés dans Quant.
- Format des enregistrements exportés
Chaque enregistrement exporté contient les éléments suivants :
Nom | Description | Type |
Equipment ID | ID de l'aménagement auquel l'image appartient. | texte |
ID | ID de l'image. | texte |
Uploaded | Date de téléchargement de l'image. | date |
Uploaded By | Utilisateur qui a téléchargé l'image. | texte |
PhotoID | ID de téléchargement de la photo (voir instructions ci-dessous). | texte |
Implemented Planogram Id | ID pour télécharger l'image du planogramme auquel la photo est associée (voir les instructions ci-dessous). Si vide, la photo n'a pas été exportée comme photo de mise en œuvre. | texte |
Title | Nom personnalisé de l'image saisi par l'utilisateur. | texte |
Description | Description personnalisé de l'image. | texte |
Télécharger une photo d'aménagement
Pour télécharger une photo d'un aménagement, utilisez l'attribut PhotoID d'un enregistrement exporté.
- Requête
Paramètre | Valeur |
URL | /downloadImage/<PhotoID> |
Header | Authorization: Bearer <TOKEN> Le TOKEN s'obtient via /authenticate (voir le manuel REST API Introduction et connexion). |
Method | GET |
Requête
curl -o image.jpg -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/downloadImage/105
Réponse
Une image JPEG binaire.
Télécharger une photo de planogramme
Pour télécharger l'image d'un planogramme, utilisez l'attribut ID du planogramme mis en œuvre d'un enregistrement exporté.
- Requête
Paramètre | Valeur |
URL | /downloadPlanogramImage/<PlanogramID> |
Header | Authorization: Bearer <TOKEN> Le TOKEN s'obtient via /authenticate (voir le manuel REST API Introduction et connexion). |
Method | GET |
Requête
curl -o planogram.jpg -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/downloadPlanogramImage/96444>
Réponse
Une image JPEG binaire dont les dimensions respectent les limites définies dans les paramètres d'exportation.