RetailForce Cloud API

The RetailForce Cloud API provides all the functions of the Cloud Portal. This can be used to automate processes or to call functions from external systems without logging into the portal and performing activities manually.

Authentication

To use the functions, the requesting system must authenticate with the cloud system. The following describes manual authentication as well as examples for event-driven calls.

Access via api.retailForce.cloud

The Cloud API is available at the following URL:

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

Manual Authentication

Authentication is done via CloudApiKey and CloudApiSecret and the generation of a Bearer Token.

1. Call Endpoint

1. Click on the endpoint POST /api/v1.0/authenticate/logon to expand the section.
2. Enter your apiKey and apiKeySecret in the corresponding fields.
3. Execute the request to receive a Bearer Token.

2. Use Bearer Token

1. Copy the Bearer Token from the ResponseBody.
2. Click the "Authorize" button at the top right of the Swagger UI.
3. Enter the Bearer Token in the dialog box. Format: Bearer <token> (insert a space after "Bearer").
4. Click "Authorize"

Automatic Authentication

Automatic authentication allows systems to securely access the RetailForce Cloud API without user interaction, ideal for background services, automated workflows, or regular data queries.

1. Authentication and Receiving Bearer Token:

Send a POST request with your API credentials to the authentication endpoint.

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

Upon successful authentication, you will receive a Bearer Token in the ResponseBody, which is required for authorizing further API requests.

2. Access Endpoints:

Use the received Bearer Token to access endpoints.

Example:

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

Important: Keep your API credentials and tokens secure to prevent unauthorized access.

Cloud Fiscalization

"Cloud Fiscalization" refers to the provision of the RetailForce fiscalization middleware as a hosted cloud service. The service is operated by RetailForce in the cloud environment.

Access via fiscalisation.retailforce.cloud

Access the service via the following link:

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

Manual Authentication

There are two options for authentication to the RetailForce Cloud Fiscalization via the Swagger UI:

1. Open the Swagger UI and click on "Authorize".
2. Authentication methods
   1. Portal credentials (email & password):
      • Allows access to multiple organizations.
   2. API Key and Secret:
      • Typically linked to a specific distributor or organization.
3. Click "Authorize"

You are now authorized to test and begin using the cloud fiscalization.