DOCS

Utilisation de l'API

Surveillez le volume d'appels et l'utilisation de l'API de votre organisation par produit, et exportez votre historique d'utilisation au format CSV.

La page Utilisation du Dashboard montre comment votre organisation utilise l'API Zonos au fil du temps. Vous verrez votre volume total d'appels, les produits que vous utilisez le plus souvent et l'évolution de leur utilisation mensuellement - et pourrez exporter les données sous-jacentes sous forme de fichier CSV pour un rapprochement, un examen de la facturation ou une analyse plus approfondie.

Ouvrez la page en vous connectant à Dashboard et en sélectionnant Usage dans la navigation de gauche.

Lire le Dashboard 

En haut de la page, deux fiches récapitulent votre activité pour la période sélectionnée :

  • Total des appels API — Le nombre total d'appels API au cours de la période sélectionnée. Avec une granularité mensuelle, cette carte montre également la variation en pourcentage par rapport au mois précédent.
  • L'API la plus utilisée — Le produit Zonos que vous appelez le plus souvent.

Sous les cartes, le graphique Volume API montre vos appels au fil du temps sous forme de graphique à barres empilées, codé par couleur par produit. En dessous, la répartition par type d'API répertorie chaque produit avec le nombre d'appels et la part de l'utilisation totale.

Utilisez les commandes situées au-dessus du graphique pour personnaliser la vue :

  • Plage de dates : sélectionnez 1 mois, 3 mois ou 6 mois.
  • Granularité — Regroupez les activités par Quotidien, Hebdomadaire ou Mensuel.

Quels produits API sont enregistrés 

L'utilisation est rapportée par produit Zonos afin que vous puissiez voir exactement où vont vos appels :

ProduitDescription
ClassifyDemandes de classification de code HS
Landed CostCalculs de douanes, taxes et frais
Order CompleteCommandes complétées via l'API Zonos
Denied PartyDemandes d'examen de partie refusée (Screen)
Restricted ItemVérifications de restriction d'article (Restrict)

Exporter l'utilisation au format CSV 

Pour télécharger un CSV de votre historique d'utilisation :

  1. Sur la page Usage, cliquez sur Exporter.
  2. Dans la boîte de dialogue Télécharger API utilisation CSV, sélectionnez une Plage de dates. Choisissez un préréglage : Ce mois, Le mois dernier, 7 derniers jours, 30 derniers jours, 90 derniers jours, Ce trimestre, Dernier trimestre, Année cumulée ou Année dernière - ou choisissez Personnalisé et définissez la Date de début et la Date de fin.
  3. Sous API types, sélectionnez les produits à inclure. Par défaut, tous les produits pris en charge sont sélectionnés.
  4. Choisissez une Granularité - Quotidien, Hebdomadaire ou Mensuel - pour contrôler la manière dont les lignes sont regroupées par date.
  5. Cliquez sur Télécharger.

La boîte de dialogue s'ouvre avec la plage de dates affichée sur la page et la granularité pré-remplie, vous permettant d'exporter la vue actuelle en un seul clic.

Le fichier exporté contient les colonnes suivantes :

ColonneDescription
PériodeLa tranche de dates pour la ligne, en fonction de la granularité choisie
API TypeLe produit Zonos auquel appartiennent les appels
Nombre d'appelsLe nombre d'appels API pour ce produit pendant cette période

Remarque : Si aucune utilisation ne correspond aux filtres sélectionnés, aucun fichier ne sera téléchargé et le Dashboard vous informera qu'il n'y a rien à exporter. Essayez d'élargir la plage de dates ou de sélectionner davantage de types API.

Remarque sur la migration des données d'utilisation 

Zonos a récemment migré vers un système amélioré de suivi de l'utilisation de l'API. Les données d'utilisation préalables à la migration peuvent être incomplètes ou manquantes : c'est normal. Toute utilisation future sera enregistrée avec précision.

Cette page a-t-elle été utile?