Accès API : comprendre le fonctionnement
Mots clés : API, accès API, documentation API, token, bearer, CustomerID, requêtes APIs, JSON, Restful, Postman, automatisation, données de ventes, accès aux données
Qu'est-ce qu'une API ?
Une API (Application Programming Interface) est un mécanisme qui permet à un logiciel externe de consulter automatiquement certaines données de votre établissement.
Concrètement, au lieu de devoir exporter manuellement des fichiers ou des rapports, une API permet à un outil tiers de récupérer directement les informations dont il a besoin de manière sécurisée et automatisée.
L'API agit comme une passerelle entre notre solution et les applications que vous souhaitez utiliser pour exploiter vos données.
À quoi sert une API ?
L'accès API permet principalement d'exploiter les données de votre établissement dans des outils externes afin de répondre à des besoins spécifiques.
Par exemple, les données récupérées peuvent être utilisées pour :
- créer des tableaux de bord personnalisés ;
- suivre l'évolution du chiffre d'affaires ;
- analyser les ventes par produit ou famille ;
- réaliser des rapports financiers avancés ;
- consolider les données de plusieurs établissements ;
- calculer des indicateurs de performance ;
- analyser les marges ;
- optimiser les achats et les coûts ;
- alimenter des outils décisionnels ou de reporting ;
- réaliser des analyses personnalisées grâce à l'intelligence artificielle.
Les données restent la propriété du client et peuvent être exploitées librement dans le respect des conditions d'utilisation du service.
Comment obtenir un accès API ?
Pour garantir la sécurité des données, les accès API sont créés et administrés exclusivement par notre service technique (sous condition de souscription à l'offre réservée)
NON DISPONIBLE - Cette offre est encore en cours de création au moment de la rédaction de ce document
La mise en place d'un accès nécessite :
- la création d'identifiants dédiés (login et mot de passe) ;
- l'association de ces identifiants aux établissements autorisés ;
- la validation des droits d'accès ;
- la mise à disposition de la documentation technique.
Chaque accès est personnel et doit être conservé de manière sécurisée.
Documentation et points d'accès disponibles
Une fois les accès créés, un espace de documentation en ligne est mis à disposition.
Cette documentation décrit l'ensemble des points d'accès (appelés "endpoints") permettant de consulter les différentes données disponibles.
Selon les besoins, il est notamment possible de récupérer :
- les chiffres d'affaires ;
- les ventes détaillées ;
- les tickets ;
- les règlements ;
- les remises ;
- les statistiques de vente ;
- les informations produits ;
- et d'autres informations financières ou analytiques disponibles au sein de la plateforme.
La documentation fournit également des exemples de requêtes et les informations nécessaires pour connecter un outil tiers à l'API.
La documentation fournit le Bearer token qui permettra de vous identifier dans notre système d'informations (qui je suis ?) ainsi qu'à la liste des établissements liés à votre compte (pour quel établissement je fais ma requête ?)
Exemples
On peut utiliser Postman ou CURL dans un terminal pour effectuer quelques essais et établir une première connexion tenant compte des accès communiqués
Indiquer les accès dans les headers
Utiliser le endpoint correspondant au besoin recherché
Récupérer et traiter le résultat (avec un logiciel ou programme externe)
Bonnes pratiques d'utilisation
L'utilisation des API repose sur des infrastructures techniques qui permettent de stocker, sécuriser et transmettre les données de l'ensemble des établissements.
Chaque requête effectuée vers l'API mobilise différentes ressources :
- puissance de calcul des serveurs ;
- accès aux bases de données ;
- bande passante réseau ;
- systèmes de supervision et de sécurité ;
- mécanismes de sauvegarde et de réplication.
Une requête isolée représente une charge très faible. En revanche, lorsqu'un système effectue plusieurs milliers de requêtes par jour ou interroge inutilement les mêmes données à intervalles très rapprochés, l'impact sur les ressources devient significatif.
Pour cette raison, il est recommandé de :
- récupérer uniquement les données réellement nécessaires ;
- éviter les appels répétés sur des informations déjà collectées ;
- privilégier des synchronisations périodiques adaptées aux besoins réels ;
- limiter les requêtes automatiques excessivement fréquentes ;
- mettre en place des mécanismes de mise en cache lorsque cela est possible.
Ces bonnes pratiques permettent de garantir des performances optimales pour l'ensemble des utilisateurs tout en réduisant la consommation de ressources informatiques et énergétiques associées aux traitements.
Notre objectif est de fournir un accès fiable, performant et durable aux données, dans l'intérêt de tous les utilisateurs de la plateforme.
Une API n'est pas une bibliothèque de fichiers statiques : chaque requête déclenche un traitement sur nos infrastructures. Une utilisation raisonnée permet donc de garantir de bonnes performances pour tous les utilisateurs.