Utiliser les APIs de la plateforme pour en extraire des informations

Utiliser les APIs de la plateforme pour en extraire des informations Une API, pour Application Programming Interface, est un programme permettant à deux applications distinctes de communiquer entre elles et d’échanger des données. Nos APIs sont là pour faire le lien entre vos données existantes dans la plateforme et toute application tierce de votre choix capable de recevoir ces données. Nos APIs sont privées (enterprise APIs). Elles sont sécurisées et disposent d’une clé d’identification (access_token), fournie par un service d’authentification et d’autorisation (oauth/token). Notre protocole de communication est basé sur le REST (Representational State Transfert) afin d’être compatibles aux diverses plateformes mobiles, qu’il s’agisse d’une application Windows, Apple ou Android. Nous vous conseillons l'utilisation de l'interface POSTMAN si vous souhaitez tester la formulation de vos requêtes vers les APIs.

Les données que vous pouvez extraire en GET CATEGORIES • liste des catégories • détails des catégories PRODUITS • liste des produits • détails des produits CLIENTS • liste des clients • détails des clients par ID • détails des clients par email POINTS DE VENTE • liste des points de vente • détails d'un point de vente par ID • détails des locations par ID de point de vente • détails des stocks par ID de point de vente • détails des transactions par ID de point de vente LOCATIONS • liste des locations • détails des locations EXPORTS • export des paiements en caisse • export des paiements en ligne Les données que vous pouvez injecter en POST • créer un client • créer une location

Générer votre token dans Outils

Clés API Cliquez sur Créer des identifiants. Choisissez le nom à associer à vos identifiants, et cliquez sur SAUVEGARDER en bas à droite. vVotre ID client et votre clé secrète seront automatiquement générés par la plateforme. Une notification vert s'affiche en haut à droite de la fenêtre lorsque vos clés ont été créées avec succès. Copiez votre ID client et votre clé secrète vous en aurez besoin à l'étape 6, c'est ce couple d'identifiants qui constitue votre token. Accéder aux APIs de votre plateforme Pour des raisons de sécurité, l'accès à la documentation API n'est pas possible depuis le BO. Si vous avez besoin d'utiliser la documentation API Rental, merci d'- ouvrir un ticket au support afin de réclamer vos accès.

Une fois que vous avez accès à votre doc API, configurez votre access_token via /openapi/V1/ Cliquez sur le bouton "AUTHO- RIZE. Et collez le token obtenu dans la pop-in d’autorisation global qui apparaît. Remplacez less client_ID et client_secret préremplis par les clés générées à l'étape 4. Vous êtes maintenant loggué et votre token sera automatiquement envoyé pour autoriser chacun de vos appels.

Exemple d'appel vers la liste des catégories Ouvrez le menu GET/categories en cliquant sur la flèche au bout à droite puis cliquez sur EXECUTE. La réponse de l'API Category List s'affiche en dessous Vous pouvez si besoin télécharger la réponse du serveur au format JSON. En bas de la réponse, cliquez sur DOWNLOAD, pour télécharger le fichier.

Format des réponses Vous trouverez le détail du format des réponses, et notamment des éventuelles réponses en erreur, en bas de la documentation sous "SCHEMAS". Si vous souhaitez utiliser en parallèle Postman, authentifiez vous également sur votre application avec le même access token Option 1 : Authentifiez vous avec un bearer token dans le header. Et enfin testez l'appel Par exemple pour la liste des catégories. Attention : une limite d'un appel par seconde est en place afin d'éviter les surcharges serveur.

Lors de l'ajout de votre API, vous pouvez voir sa date d'expiration