REST API Exportation des analyses
Cette source est utilisée pour exporter des analyses dans Quant. Les analyses suivantes peuvent être exportées : Aperçu des produits placés, Opportunités de catégorie, Aperçu des aménagements, Planogrammes de projet publiés, Planogrammes autonomes publiés, Remplacements planifiés, Résultats de formulaires, Analyse des photos de mise en œuvre. Les formats d'entrée et de sortie sont tous deux en JSON.
Aperçu des produits placés
Cette analyse permet d'exporter soit les produits des planogrammes, soit les produits en réserve. Elle fournit une vue d'ensemble de tous les produits présents sur les planogrammes avec le statut de cycle de vie sélectionné.
Opportunités de catégorie
Elle fournit une comparaison détaillée de l'espace alloué à une catégorie de produits donnée dans un magasin, à la fois en termes d'aménagements disponibles et de ventes des produits dans cette catégorie.
Aperçu des aménagements
Elle fournit un aperçu de tous les aménagements situés dans les magasins.
Planogrammes de projet publiés
Elle fournit une vue d'ensemble de tous les planogrammes de tous les projets.
Planogrammes autonomes publiés
Elle fournit une vue d'ensemble de tous les planogrammes autonomes.
Remplacements planifiés
Affiche les remplacements planifiés des articles dans les magasins sélectionnés.
Résultats de formulaires
Elle fournit une vue d'ensemble des formulaires complétés.
Implementation Photos Analysis
Displays an overview of the implementation photos.
Utilisez la section Tâches automatiques pour créer et configurer une exportation. Une fois créée, la liste des tâches contiendra l'ID que vous devez transmettre dans l'URL de la requête.
Tâche automatique
ID de tâche automatique
Paramètres
Avant d'utiliser l'API, vous devez modifier les attributs suivants dans l'onglet Paramètres :
- Cochez l'attribut Activé pour autoriser la tâche.
- Dans Utilisateurs avec autorisation API, sélectionnez un ou plusieurs utilisateurs ayant le rôle Robot et pouvant exécuter la tâche.
- Dans l'attribut Analyses, sélectionnez celles que vous souhaitez exporter.
- Dans Mappage des attributs d'analyse, sélectionnez les attributs à exporter et modifiez éventuellement leurs clés JSON.
- Nous recommandons également de renseigner les e-mails pour les notifications, où vous pouvez saisir une ou plusieurs adresses e-mail auxquelles seront envoyés des e-mails relatifs aux statuts d’erreur.
Attributs
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 |
Emails pour notifications | Une ou plusieurs adresses e-mail pour recevoir les erreurs éventuelles. | liste de chaînes |
Utilisateurs avec autorisation API | Utilisateurs avec le rôle Robot autorisés à exécuter la tâche. | liste des utilisateurs |
Délai en secondes avant nouvelle tentative | Nombre de secondes pendant lesquelles le client doit attendre avant de réessayer l'exportation en cas de file d'attente de requêtes vers le serveur trop longue. | nombre entier |
Mappage des attributs d'analyse | Mappage contenant une entrée pour chaque attribut à exporter. | type complexe |
Unité de mesure | Unité comme cm, mm, etc. | sélection |
Format de date | Format de date, par ex. 31.12.19 | sélection |
Format date et heure | Format de date et heure, par ex. 19.12.31 23:59:59 | sélection |
Séparateur des éléments de liste | Symbole utilisé pour séparer les éléments dans une liste de valeurs. | symbole |
Analyse | Sélection des analyses. | liste d'analyses |
Critères d'analyse | Sélection des critères selon lesquels l'analyse doit être exportée. | type complexe |
Paramètres et attributs importants
- Requête
/v1/export/analyze-report/{task_id}
Paramètre | Valeur |
URL | Ajoutez ?debug à l'URL pour afficher aussi les avertissements. Sinon, seules les messages d'erreurs sont affichés. |
Header | Accept: application/json |
Header | Content-type: application/json |
Header (optional) | Accept-Encoding: gzip |
Header | Authorization: Bearer <TOKEN> Le TOKEN s'obtient via /authenticate (voir la section Connexion). |
Method | POST |
Le contenu de la requête d'analyse Aperçu des aménagements est un objet JSON contenant les clés suivantes :
Clé | Valeur |
StoreID | Dans la requête, vous devez préciser pour quel magasin les données du produit doivent être exportées. Il est toujours possible de sélectionner un seul magasin. Exemple: { "StoreID":"12"} |
Réponse
Clé | Valeur |
Status | Une chaîne indiquant l'état final de l'exportation.
|
Warnings | Il est facultatif, c'est-à-dire qu'il n'est inclus que si le paramètre ?debug est présent dans l'URL et que l'exportation a généré au moins un avertissement. Liste des chaînes d'avertissement. |
Errors | Facultatif - inclus uniquement si l'exportation a généré au moins une erreur. Liste des chaînes d'avertissement. |
Record | Optionnel - inclus si l'exportation ne s'est pas terminée avec le statut « FAILURE ». Liste d'objets exportés avec la clé de correspondance définie dans les paramètres de la tâche. |
Codes de statut
Statut | Valeur |
200 OK | Exportation réussie avec le statut « SUCCESS » ou « PARTIAL_SUCCESS ». La réponse peut contenir des avertissements ou des erreurs mineures. |
400 Bad Request | Paramètres de tâche ou requête incorrects. |
401 Unauthorized | Le jeton d'autorisation invalide ou l'utilisateur connecté avec ce jeton n'est pas autorisé à exécuter cette tâche. |
404 Not Found | Aucune tâche trouvée avec l'ID spécifié dans l'URL. |
500 Internal Server Error | Une erreur serveur critique s'est produite lors de l'exportation. |
503 Service Unavailable | La tâche est déjà en cours d'exécution. Réessayez de lancer la tâche après un délai indiqué dans l'en-tête de réponse Retry-After. |
Journal d'exécution
Dans Quant, en plus des paramètres des tâches, vous pouvez également consulter l'historique des exportations individuelles, avec les statistiques, erreurs et avertissements.Journal d'exécution
Si vous sélectionnez un enregistrement spécifique, vous pouvez afficher ses détails en cliquant sur le bouton Afficher les éléments.
Afficher les éléments
Requête pour Aperçu des produits placés, Opportunités de catégorie, Planogrammes de projets publiés, Planogrammes autonomes publiés, Remplacements planifiés, Résultats de formulaires, Analyse des photos de mise en œuvre
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/export/analyze-report/117131?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
Requête pour Aperçu des aménagements
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/export/analyze-report/117131?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{ \"StoreID\": \"12564\"}]"
Réponse
{
"Status": "SUCCESS", "Records": [
{"Store ID": "234", "Store Name": "Kutná Hora", "City": "Kutná Hora", "Fixture type": "Freezer", "Number of Shelves": "5", "Category Name": "Doplňky", "Category Id": "CAT6"},
{"Store ID": "238", "Store Name": "Ostrava-Svinov", "City": "Ostrava", "Fixture type": "Default", "Number of Shelves": "6", "Category Name": "Yoga", "Category Id": "CAT931"},
{"Store ID": "545", "Store Name": "Kolín", "City": "Kolín", "Fixture type": "Default", "Number of Shelves": "6", "Category Name": "Milk", "Category Id": "CAT14"},
... ]
}