RetailForce Cloud API

Die RetailForce Cloud API bietet sämtliche Funktionen des Cloud Portals an. Dies dient etwa dazu Abläufen zu automatisieren oder zum Aufruf von Funktionen aus externen Systemen heraus, ohne sich in das Portal einzuloggen und die Tätigkeiten manuell ausführen zu müssen.

Authentisierung 

Um die Funktionen nutzen zu können, muss sich das anfragende System gegenüber dem Cloud-System authentisieren. Nachfolgend wird die manuelle Authentisierung beschrieben, sowie Beispiele im Fall des eventgesteuerten Aufrufes angeführt.

Zugriff über api.retailForce.cloud

Die Cloud-API wird über die folgende URL zur Verfügung gestellt:

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

Manuelle Authentisierung

Die Authentisierung erfolgt über CloudApiKey und CloudApiSecret sowie der Erzeugung eines Bearer Tokens.

1. Aufrufen Endpunkt

1. Klicken Sie auf den EndpunktPOST /api/v1.0/authenticate/logon, um den Abschnitt zu erweitern.
2. Geben Sie IhrenapiKeyundapiKeySecret in die entsprechenden Felder ein.
3. Führen Sie die Anfrage aus, um einen Bearer-Token zu erhalten.

2. Verwenden Bearer-Token

1. Kopieren Sie das Bearer-Token aus dem ResponseBody.
2. Klicken Sie auf die Schaltfläche "Authorize" oben rechts in der Swagger UI.
3. Geben Sie das Bearer-Token im Dialogfeld ein. Format: Bearer <token> (fügen Sie ein Leerzeichen nach "Bearer" ein).
4. Klicken Sie auf "Authorize"

Automatische Authentisierung

Automatische Authentifizierung ermöglicht es Systemen, ohne Benutzerinteraktion sicher auf die RetailForce Cloud API zuzugreifen, ideal für Hintergrunddienste, automatisierte Workflows oder regelmäßige Datenabfragen.

1. Authentisierung und Bearer-Token Erhalt:

Senden Sie eine POST-Anfrage mit Ihren API-Zugangsdaten an den Authentifizierungsendpunkt.

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

Bei erfolgreicher Authentifizierung erhalten Sie im ResponseBody ein Bearer-Token, die für die Autorisierung weiterer API-Anfragen benötigt wird.

2. Zugriff auf Endpunkte:

Verwenden Sie das erhaltene Bearer-Token, um Endpunkte abzurufen.

Beispiel:

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

Wichtig: Bewahren Sie Ihre API-Zugangsdaten sowie Tokens sicher auf, um unbefugten Zugriff zu verhindern.

Cloud Fiskalisierung

Mit "Cloud Fiskalisierung" wird die Zurverfügungstellung der RetailForce Fiskalisierungsmiddleware als gehostetes Cloud Service verstanden. Der Service wird durch RetailForce in der Cloud-Umgebung betrieben.

Zugriff über fiscalisation.retailforce.cloud

Über den nachfolgenden Link erhalten Sie Zugriff auf den Dienst:

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

Manuelle Authentisierung

Für die Authentifizierung an der RetailForce Cloud Fiskalisierung über die Swagger UI gibt es zwei Optionen:

1. Öffnen Sie die Swagger UI und klicken Sie auf "Authorize".
2. Authentifizierungsmethoden
   1. Portal-Zugangsdaten (E-Mail & Passwort):
      • Erlaubt Zugriff auf mehrere Organisationen.
   2. API-Key und Secret:
      • Verknüpft meist mit einem spezifischen Distributor oder einer Organisation.
3. Klicken Sie auf "Authorize"

Nun sind Sie berechtigt, die Cloud-Fiskalisierung zu testen und die zu beginnen.