Configuration du filigrane

Ces routes lisent et modifient la configuration globale des filigranes appliqués aux courriers, aux pièces jointes et, lorsque le nouveau parapheur interne est activé, aux signatures électroniques.

Lire la configuration du filigrane

Route

GET /rest/watermark/configuration

Authentification, privilège et périmètre

L'authentification REST et le privilège admin_parameters sont obligatoires. La configuration porte sur l'instance complète, sans restriction par entité.

Retour

Code HTTP	Type	Description	Exemple
200	object	Configuration des filigranes	Voir l'exemple ci-dessous
200	object	La configuration du filigrane des courriers n'existe pas encore	{"configuration":null}
403	object	Privilège absent	{"errors":"Service forbidden"}

La propriété electronicSignature est présente uniquement lorsque le nouveau parapheur interne est activé.

{
  "configuration": {
    "documents": {
      "enabled": true,
      "text": "Copie conforme de [alt_identifier] le [date_now] [hour_now]",
      "posX": 30,
      "posY": 35,
      "angle": 0,
      "opacity": 0.5,
      "font": "helvetica",
      "size": 10,
      "color": [20, 192, 30]
    },
    "attachments": {
      "enabled": true,
      "text": "Copie conforme de la PJ [identifier] le [date_now] [hour_now]",
      "posX": 20,
      "posY": 35,
      "angle": 0,
      "opacity": 0.5,
      "font": "helvetica",
      "size": 10,
      "color": [51, 7, 122]
    },
    "electronicSignature": {
      "enabled": true,
      "text": "Signé électroniquement par [user_firstname] [user_lastname] le [current_date]",
      "posX": 70,
      "posY": 8,
      "angle": 0,
      "opacity": 0.8,
      "font": "helvetica",
      "size": 10,
      "color": "#c11010",
      "dateFormat": "d/m/Y H:i:s"
    }
  }
}

Modifier la configuration du filigrane

Route

PUT /rest/watermark/configuration

Authentification, privilège et périmètre

Les contrôles sont identiques à ceux de la lecture. La modification est globale à l'instance.

Body

Valeur	Type	Obligatoire	Description
documents	object	Oui	Filigrane des courriers
attachments	object	Non	Filigrane des pièces jointes
electronicSignature	object	Non	Filigrane de signature, traité uniquement lorsque le nouveau parapheur interne est activé

Filigranes documents et attachments

Valeur	Type	Obligatoire	Description
enabled	boolean	Non	Active le filigrane. La valeur enregistrée par défaut est false
text	string	Oui	Texte du filigrane. Les champs et variables sont écrits entre crochets
posX	number	Oui	Position horizontale
posY	number	Oui	Position verticale
angle	number	Oui	Angle de rotation en degrés
opacity	number	Oui	Opacité du texte
font	string	Oui	Police utilisée
size	number	Oui	Taille de la police
color	array de 3 nombres	Oui	Couleur RGB, par exemple [20, 192, 30]

Pour documents, le texte peut notamment reprendre une colonne de res_letterbox, telle que [alt_identifier], ainsi que [date_now] et [hour_now]. Pour attachments, les colonnes de res_attachments, telles que [identifier], sont disponibles.

Filigrane electronicSignature

La structure reprend les champs précédents, avec les différences suivantes :

Valeur	Type	Obligatoire	Description
color	string	Oui	Couleur hexadécimale au format #RRGGBB
dateFormat	string	Oui	Format parmi d/m/Y H:i:s, m/d/Y H:i:s, Y-m-d H:i:s, d-m-Y H:i, m-d-Y H:i et Y/m/d H:i

Le body de l'exemple de lecture peut être réutilisé après retrait de la propriété racine configuration.

Retour

Code HTTP	Type	Description	Exemple
204	vide	Configuration enregistrée	Aucune réponse
400	object	documents est absent ou vide	{"errors":"Parameter 'body' cannot be empty"}
400	object	text ou font est absent ou n'est pas une chaîne	{"errors":"Parameter 'text' is empty or not a type 'string'"}
400	object	La couleur RGB ne contient pas exactement trois nombres	{"errors":"Invalid RGB color array"}
400	object	Une position ou une valeur numérique est invalide	{"errors":"Invalid numeric value : posX"}
400	object	La couleur ou la date de signature est invalide	Le message précise la valeur concernée
403	object	Privilège absent	{"errors":"Service forbidden"}

Les messages issus des problèmes de validation peuvent être traduits selon la langue active de l'instance.