Le DFM est une interface retraçant l'historique des appels échangés avec les connexions externes.
Il vous permet de pouvoir accéder aux appels effectués entre les deux entités afin de pouvoir visualiser les données si vous veniez à rencontrer une erreur.
Accéder au DFM depuis l'interface Shippingbo
Pour accéder au DFM depuis l'ancienne interface Shippingbo, rendez-vous dans le menu Configurations -> Service Externes -> Entrez dans les détails du service pour lequel vous souhaitez accéder aux appels puis cliquez sur "Logs" :
Pour accéder au DFM depuis la nouvelle interface Shippingbo, rendez-vous directement dans les configurations de votre connecteur, cliquez sur les trois petits points à droite de la catégorie "Etats des services" puis cliquez sur "Logs" :
Vous serez directement redirigé vers le DFM (appelé aussi Sbug) où les premiers champs de recherches seront renseignés par défaut (Catégorie et ID du service) :
REMARQUE
Vous pouvez également accéder directement au DFM en suivant cette URL : https://call-history.shippingbo.com/
Différents critères de recherches possibles
4 critères peuvent être renseignés afin d'affiner au mieux votre recherche.
Category :
-
Service Credential : rechercher des appels concernant les services externes connectés au compte Shippingbo
-
Address Label Config : retrouver les appels concernant la génération d'étiquettes de transport
-
Update Hook : retrouver les webhooks
-
OrderSentNotification : notification email / SMS
Service : Renseignez ici l'id du service externe, du compte étiquette, de la configuration de la notification ou du hook sur lequel vous souhaitez effectuer votre recherche.
Action :
-
Service Credential :
- Stock Deliverer : appel concernant l'envoi de stock vers un service externe
- Order Deliverer : appel concernant l'envoi de commande vers le service externe (existant pour les connecteurs avec les logisticiens externes, pour la création de facture Sellsy à partir de commande Shippingbo, pour FBA et FBC)
- Shipment Deliverer : clôture d'une commande non créée dans le service externe
- Order Updater : appel pour mettre à jour une commande (envoi des informations de clôtures par exemple)
- SupplyCapsule Updater : attendu de réception reçu par API
- Order Fetcher : appel concernant la récupération des commandes
- Product Fetcher : appel concernant la récupération des produits
- Common Fetcher : toutes les informations récupérées, autres que produit et commande
- Other Actions : autres appels : batchs, vérification si service externe fonctionnel, etc.
- Address Label Config :
- Address Label : tous les appels concernant la génération des étiquettes, documents dématérialisés, etc.
- Update Hook : détail des webhooks
- SMS Sent :
- SMS Sent : appel concernant l'envoi du SMS
- URL Shortener : appel concernant la réduction de la taille du lien de tracking
- Email Sent : appel concernant l'envoi de la notification par email
Context (optionnel) :
- ID Produit
- ID Commande
Effectuer une recherche dans le DFM
Pré-requis :
- être connecté à votre compte Shippingbo
- l'historique des requêtes est conservé 33 jours dans le DFM, l'information recherchée ne doit pas être plus ancienne que cela.
Etape 1: récupérez l'ID du service pour lequel vous souhaitez effectuer une recherche
Etape 2 : renseignez les filtres souhaités.
Exemple : il s'agit ici de consulter une mise à jour de la commande sur le Prestashop-3487 : Nous avons renseigné ici dans les filtres le Service Credential 3487 ; l'Action "order updater" (mise à jour des commandes) ainsi que l'ID de la commande comme contexte :
Etape 3 : Analysez ici la recherche en téléchargeant les fichiers de Requête et de Réponse.
Ici, on peut voir que la requête est revenue avec une erreur 500. Il est possible de consulter les détails de cette erreur en téléchargeant le fichier de réponse.
Etape 4 : Selon la nature de l'erreur, vous pouvez la transmettre à votre webmaster ou agence web afin de la corriger ; ou bien vous pouvez l'envoyer à Shippingbo via une demande au service support si l'erreur vient de Shippingbo.
REMARQUE
Les différents types de codes renvoyés lorsque l'appel est fait sont les suivants :
- Code 200 ✅ : tous les codes autour des 200 indique que l'appel s'est bien passé dans la plupart des cas. Attention : il arrive parfois qu'un appel ayant un code 200 comprenne une erreur dans le body de la réponse.
- Code 400 ❌ : tous les codes autour des 400 indique qu'il y a eu une erreur au moment de l'envoi (404 Not Found, 403 Forbidden, etc)
- Code 500 ❌ : tous les codes autour des 500 indique que la requête a été reçue mais il y a une erreur sur l'interface de reception (503 Service Unavailable).
REMARQUE
Il est également possible de retrouver les appels effectués pour les envois de notification d'états par email ou par SMS.
- Pour ceci, récupérez en premier l'ID de la notification dans le menu correspondant :
- Puis, rendez-vous dans le DFM et sélectionnez :
- OrderStateNotification dans la Catégorie
- renseignez l'ID de la notification récupérée précédemment dans Service
- Email Sent ou SMS Sent (en fonction du type de notification) dans Action :
Analyser les différents appels
Requête HTTP
Une requête HTTP concerne la plupart des appels référencés dans le DFM. Une requête HTTP se compose :
- Méthode :
- PUT pour mettre à jour une donnée
- POST s'il s'agit d'une création
- GET s'il s'agit d'une récupération d'information
- URL appelé
- Contexte : données utilisées pour la récupération ou l'envoi de la donnée ( ce sont toujours des valeurs Shippingbo)
- Header : Informations d'authentification et/ou propres à l'envirronement d'appel
- Body : contenu de la requête
FTP et SOAP
Cela concerne les transferts de fichier par FTP notamment. Ils se composent :
- Action remplace la Méthode
- Paramètre de lecture/écriture à la place de l'URL
- Contexte : données utilisées pour la récupération ou l'envoi de la donnée (ce sont toujours des valeurs Shippingbo)
- Fichier déposé ou lu sur le FTP
