Ce point de terminaison permet la restauration d’un client dans le RetailForce Middleware, à partir des données (y compris les informations de configuration) issues du RetailForce Cloud.
La récupération d’un client peut s’avérer nécessaire en cas de changement de matériel de caisse ou de défaillance matérielle.
La fonction POST /api/v1/management/clients/recovery/restoreByCloud est pour l’essentiel identique à PUT /api/v1/management/clients/byCloud, mais cette dernière ne peut être exécutée qu’une seule fois lors de la mise en service initiale d’un client.
Résultat
Un appel réussi vers le point de terminaison (200) :
- Télécharge à nouveau l’objet de configuration du client concerné depuis le système Cloud et configure le client en conséquence.
- Restaure un client déjà mis en service dans le middleware et lui attribue l’uniqueClientId correspondant du terminal provenant du RetailForce Cloud.
Utilisation
Ce point de terminaison est utilisé lorsqu’un client, qui a déjà été créé une fois et dont le clientId est connu, doit être restauré (par exemple, en cas de changement de matériel).
Conditions préalables
- Le client doit avoir été créé au moins une fois et son ClientId doit être connu.
- La structure organisationnelle et l’objet de configuration ont été créés dans RetailForce Cloud et attribués en conséquence.
- Les valeurs « storeNumber » et « terminalNumber » sont connues.
- Le « LicenseConsumerId » est connu.
- Le Fiscal Middleware est installé.
- La fonction « restoreByCloud » ne peut être utilisée que si :
- une licence correspondante est utilisée (pack de licences incluant « Cloud Archive Access »),
- la case à cocher « Cloud Archive » est activée dans la configuration (Cloud),
- le client a déjà transféré des données vers l’archive Cloud (AVANT la restauration).
- En Allemagne, au moins une clôture journalière (à n’importe quel moment dans le passé) doit avoir été enregistrée dans le client et transférée vers l’archive Cloud.
Remarque : restoreByCloud ne fonctionnera correctement que si
- le middleware a été fraîchement installé sur le système AVANT d’exécuter restoreByCloud,
- ou, à défaut de réinstallation, si le service de fiscalisation (service RetailForce) a été redémarré avant l’exécution de RestoreByCloud.
Champs du formulaire
Les informations suivantes doivent être fournies :
| Nom | Description | Exemples |
| LicenseConsumerId | L'identifiant de l'organisation. | ID : d92254ca-d0fe-XXXX-bc3c-XXXXXX |
| storeNumber |
Le numéro de la succursale où se trouve la caisse. Doit correspondre aux informations saisies dans RetailForce Cloud. Informations relatives au pays :
|
|
| terminalNumber | Numéro de caisse. Doit correspondre aux informations saisies dans RetailForce Cloud. | 0010 |
| cloudApiKey | Clé API permettant d’authentifier la communication avec le Cloud | RFC_4a2abc... |
| cloudApiSecret | API Secret pour l'authentification de la communication avec le Cloud | ypts7u5OU... |
Réponse
Réponses possibles :
| Code | Description | Exemple |
| 200 | Le client a été restauré et configuré avec succès. L’objet de réponse renvoie l’identifiant unique (uniqueClientId) du client restauré. Cet identifiant unique doit être enregistré par le système de caisse et utilisé pour l’ensemble du processus de communication ultérieur concernant ce client. | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Le type de l’identifiant d’entreprise fourni n’est pas un type unique. Gestion des erreurs : Utilisez l’un des identifiants d’entreprise suivants : [0] = VatNumber, |
- |
Cet article a été traduit automatiquement.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.