Récupérer les données de shifts de caisse via API

Point de départ : votre intégration de serveur à serveur (client API).

L’API Cashrec

L’API Cashrec est un service RESTful qui permet de récupérer les données de feuilles de caisse pour des sites et des périodes spécifiques.

Principaux avantages :

• Obtenez des informations détaillées sur la caisse et les ventes au niveau du shift.
• Bénéficiez d’une intégration de serveur à serveur sécurisée et chiffrée (HTTPS + JWT).
• Traitez des volumes élevés de requêtes en temps réel.

Générer un jeton JWT

Envoyez une requête POST à : https://login.mapal-os.com/connect/token

Paramètres :

• grant_type=password
• username=
• password=
• client_id=wf_wap_tp
• client_secret= (contactez le Support client pour l’obtenir).

Champs de la réponse en cas de succès : access_token, expires_in, token_type, refresh_token, scope.

Inclure le jeton dans les requêtes

• Ajoutez l’en-tête : Authorization: Bearer {access_token}.

Obtenir les informations de feuille de caisse

• Domaine de base (OpenAPI) : https://cashrec.api.pro.mapal-os.com.
• Chemin du point de terminaison : /api/v1/cashSheet.
• Méthode : GET.
• Description : récupère les informations détaillées de feuille de caisse pour une période et une liste de sites données.

Paramètres de requête

• startDate (format : yyyy-MM-ddTHH:mm:ss).
• endDate (format : yyyy-MM-ddTHH:mm:ss).
• centersList (liste d’identifiants de sites séparés par des virgules).
• Réponse : 200 OK avec les enregistrements de feuilles de caisse pour la période et les sites demandés.

Remarque : les noms des paramètres peuvent être sensibles à la casse. Utilisez les noms exacts indiqués dans votre spécification OpenAPI s’ils diffèrent (par exemple, StartDate au lieu de startDate). Pour le schéma complet des requêtes et des réponses ainsi que la documentation interactive, consultez la spécification OpenAPI : https://cashrec.api.pro.mapal-os.com/swagger/index.html

Erreurs de l’API

• 400 Bad Request : paramètres manquants ou non valides. Exemple de message, code 100 : « Invalid parameters. You must provide valid StartDate, EndDate and CenterLists. »
• 401 Unauthorized : jeton non valide ou manquant.
• 404 Not Found : tenant introuvable. Exemple de message, code 0 : « Tenant configuration not found. »
• 500 Internal Server Error : erreur inattendue du serveur.

Remarque : toutes les requêtes doivent utiliser HTTPS. Les jetons expirent (voir expires_in) et doivent être renouvelés à leur expiration. Si un jeton est compromis, le fournisseur de l’API peut le révoquer.