POST /api/v1/archive/de/{clientId} – RetailForce

La section ARCHIVE de l’API Middleware (Swagger) sert à transmettre (et à télécharger) des données vers le RetailForce Secure Archive sans recourir à la fiscalisation.

L’utilisation des fonctions / points de terminaison de cette section n’est nécessaire que si la fiscalisation est désactivée via le RetailForce Middleware, c’est-à-dire si elle n’est PAS utilisée.

Pour l’archivage des données dans le cadre de la fiscalisation, seule une licence correspondante est nécessaire (attribution via la configuration). Le téléchargement des données fiscales vers l’archive Cloud est alors géré automatiquement par le middleware fiscal.

L’

point de terminaison POST /api/v1/archive/de/{clientId}

est utilisé pour transférer les données vers l’archive Cloud de RetailForce.

Résultat

Un appel réussi vers le point de terminaison (200) permet de transmettre les données correspondantes vers l’archive sécurisée.

Utilisation

À chaque fois que des données doivent être transmises à l’archive à des fins de sauvegarde.

Prérequis

Le middleware RetailForce (Fiscal) doit être installé et
le client initialisé,

Demande

Champs du formulaire

Les paramètres suivants doivent être fournis :

Intitulé	Description	Exemple
clientId	L'identifiant unique « uniqueClientId » de la caisse (provenant du RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Corps de la requête

Les données à transmettre à l’archive doivent être spécifiées en conséquence. Cela s’effectue via la charge utile décrite ci-dessous dans la requête.

Exemple :

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Informations dans la colonne « Type » :

M … obligatoire / requis
M* … obligatoire / requis dans certains pays ou sous certaines conditions
R ... recommandé
O... facultatif

Éléments	Type	Description
type	M	Définition du type de données à transférer vers l’archive. Types : 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Données de sauvegarde (divers) Remarque : la taille des fichiers est limitée comme suit : Type 0 : 200 ko Type 1 : 200 ko Type 2 : 10 Mo
conteneur	M*	Nom (désignation) du conteneur (fichier .zip) Remarque : UNIQUEMENT si Type = 2 (« type » : 2,)
entité	M*	Données à transférer vers l’archive (fichier ou dossier).
récursif	M*	true si les sous-dossiers doivent également être transférés, faux dans le cas contraire. Sans objet si l'entité n'est PAS un dossier ! Remarque : UNIQUEMENT si Type = 2 (« type » : 2,)

Réponse

Réponses possibles :

Code	Description	Exemple
200	Les données ont été transmises avec succès	-

Cet article a été traduit automatiquement.