This endpoint connects a specific client (tennant) to the RetailForce Cloud and caches the Fiscal module. CloudConnect should be called before transactions are submitted to the fiscal service.
The function must be executed at least after a cash register restart, or after a restart of the system on which the Fiscal Middleware is installed. However, we recommend regular use of the endpoint to ensure a constant connection to the cloud system.
Result
A successful call of the endpoint (200)
- establishes the connection between Fiscal Client and RetailForce Cloud and
- loads the Fiscal module into the cache.
Usage
- during commissioning, after PUT /api/v1/management/clients/byCloud, or PUT /api/v1/management/clients;
- regularly, at least after each restart of the host system.
POST /api/v1/management/cloud/connect for example, can be executed before each transaction transmission.
Prerequisites
- Fiskal Middleware installed and at least PUT /api/v1/management/clients/byCloud, or PUT /api/v1/management/clients successfully executed.
Form fields
The following information must be provided:
| Designation | Description | Example |
| clientId |
The uniqueClientId of the cash register (from RetailForce system). |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
| cloudApiKey |
API Key to authenticate cloud communication |
RFC_4a2abc... |
| cloudApiSecret |
API Secret for authentication of cloud communication
Attention: API secret must always be enclosed in single quotes, e.g. 'ypmqt7s5UVZOyY9mDFzOeVgdpRnJ8GrOsQ'
|
ypts7u5OU... |
Response
Possible responses:
| Code | Description | Example |
| 200 |
Cloud connection was successfully established |
- |
| 403 |
Access data (credentials = cloudApiKey and API secret) are incorrect. Troubleshooting:
|
- |
| 422 |
The specified clientId could not be found in the local system or access data were not specified. Troubleshooting:
|
- |
| 424 |
If you want to use the cloud archive, you must call cloud connect before using the trusted fiscal module. Troubleshooting:
|
- |
Comments
0 comments
Please sign in to leave a comment.