RetailForce Cloud API

La RetailForce Cloud API offre toutes les fonctionnalités du RetailForce Cloud Portal. Elle permet d’automatiser des processus ou d’appeler des fonctions depuis des systèmes externes sans avoir à se connecter au portail ni à effectuer d’opérations manuellement.

Authentification

Pour utiliser ces fonctions, le système demandeur doit s’authentifier auprès du système Cloud. Vous trouverez ci-dessous la description de l’authentification manuelle ainsi que des exemples d’appels déclenchés par des événements.

L’accès s’effectue via l’URL api.retailForce.cloud.

La Cloud API est disponible à l’URL suivante :

• https://api.retailforce.cloud/swagger/index.html

Authentification manuelle

L’authentification s’effectue à l’aide des paramètres cloudApiKey et cloudApiSecret, suivis de la génération d’un jeton Bearer.

1. Point de terminaison d’appel

1. Cliquez sur le point de terminaison POST /api/v1.0/authenticate/logon afin d’étendre la section.
2. Saisissez vos identifiants apiKey et apiKeySecret dans les champs correspondants.
3. Exécutez la requête afin d’obtenir un jeton « Bearer ».

2. Utilisation du jeton « Bearer »

1. Copiez le jeton Bearer à partir du corps de la réponse (ResponseBody).
2. Cliquez sur le bouton « Autoriser » situé en haut à droite de l'interface Swagger UI.
3. Saisissez le jeton Bearer dans la boîte de dialogue. Format : Bearer <token> (insérez un espace après « Bearer »).
4. Cliquez sur « Autoriser ».

Authentification automatique

L’authentification automatique permet aux systèmes d’accéder de manière sécurisée à la RetailForce Cloud API sans intervention de l’utilisateur, ce qui est idéal pour les services en arrière-plan, les flux de travail automatisés ou les requêtes de données régulières.

1. Authentification et obtention du jeton « Bearer » :

Envoyez une requête POST avec vos identifiants API vers le point de terminaison d’authentification.

curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"

En cas de succès, le serveur renvoie un jeton « Bearer » dans le corps de la réponse (ResponseBody), nécessaire pour autoriser les requêtes API suivantes.

2. Accès aux points de terminaison :

Utilisez le jeton « Bearer » reçu pour interroger les points de terminaison.

Exemple :

curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'

Important : veillez à la sécurité de vos identifiants API et de vos jetons afin d’empêcher tout accès non autorisé.

Fiscalisation dans le Cloud

Le terme « fiscalisation dans le cloud » désigne la mise à disposition du middleware de fiscalisation RetailForce sous forme de service cloud hébergé. Ce service est exploité par RetailForce dans un environnement cloud.

Accès via fiscalisation.RetailForce Cloud

Accédez au service via le point d’entrée suivant :

• https://fiscalisation.retailforce.cloud/swagger/index.html

Authentification manuelle

Deux options s’offrent à vous pour vous authentifier sur RetailForce Cloud Fiscalization via l’interface Swagger UI :

1. Ouvrez l’interface Swagger UI et cliquez sur « Autoriser ».
2. Méthodes d’authentification
   1. Identifiants du portail (adresse e-mail et mot de passe) :
      • Permet d’accéder à plusieurs organisations.
   2. Clé API et secret :
      • Généralement associées à un distributeur ou à une organisation spécifique.
3. Cliquez sur « Autoriser »

Vous êtes désormais autorisé à tester et à commencer à utiliser la fiscalisation dans le Cloud.

Cet article a été traduit automatiquement.