This endpoint allows the recovery of a client in the RetailForce Middleware, with data (including configuration information) from the RetailForce Cloud.
A recovery of a client may be necessary in case of a change in cash register hardware or hardware defects.
The function POST /api/v1/management/clients/recovery/restoreByCloud is essentially identical to PUT /api/v1/management/clients/byCloud, but the latter can only be performed once at the initial commissioning of a client.
Result
A successful call to the endpoint (200):
- Restores an already existing client in the Middleware and assigns it the corresponding uniqueClientId of the terminal from the RetailForce Cloud.
- Re-downloads the configuration object from the Cloud system and configures the client accordingly.
Usage
This endpoint is used when a client, which has already been created once and whose ClientId is known, needs to be restored (for example, in case of hardware change).
Prerequisites
- The client must have been created once and the ClientId should be known.
- Organizational structure and configuration object have been created in the RetailForce Cloud and assigned accordingly.
- The `storeNumber` and the `terminalNumber` are known.
- The `LicenseConsumerId` is known.
- Fiscal Middleware is installed.
Form Fields
The following information must be submitted:
Name | Description | Examples |
LicenseConsumerId |
The ID of the organization. |
ID: d92254ca-d0fe-XXXX-bc3c-XXXXXX |
storeNumber |
The number of the branch where the cash register is located. Must match the information entered in the RetailForce Cloud.
Country details:
|
|
terminalNumber |
Cash register number. Must match the information entered in the RetailForce Cloud. |
0010 |
cloudApiKey | API Key to authenticate the Cloud communication | RFC_4a2abc... |
cloudApiSecret |
API Secret for authenticating Cloud communication |
ypts7u5OU... |
Response
Possible responses:
Code | Description | Example |
200 | The client has been successfully restored and configured. The response object returns the uniqueClientId of the restored client. The uniqueClientId must be stored by the cash register system and used for the entire further communication process concerning the client. | b7cf6d59-cec4-4cc2-a647-01XXXX |
406 |
The type of the provided company identifier is not a unique type. Error handling: Use one of the following company identifiers: [0] = VatNumber, |
- |
Comments
0 comments
Please sign in to leave a comment.