Ajouter un champ image

Un champ est l’objet qui porte l’action à effectuer par un participant. Un champ a un type qui peut être soit :

• signature (pour une demande de signature par une personne physique ou un cachet par une personne morale),
• visa (pour une demande de consultation par une personne physique),
• text (pour un champ de texte à remplir par le participant),
• label (pour un texte en lecture seule ajouté par le créateur de la transaction sur un document),
• checkbox_group (pour un groupe de cases à cocher par le participant),
• checkbox (pour une case à cocher par le participant),
• radio_group (pour un groupe de boutons radio à cocher par le participant),
• radiobutton (pour un bouton radio à cocher par le participant),
• dropdown (pour une liste déroulante dans laquelle le participant doit sélectionner une option).
• image (pour un champ image dans lequel le participant doit importer un fichier image),
• signature_date (pour un champ qui affiche la date et l’heure auxquelles le participant a signé le document),
• full_name (pour un champ qui affiche le nom complet du participant),
• email (pour un champ qui affiche l’email du participant),
• company_name (pour un champ qui affiche le nom de l’entreprise du participant),
• job_title (pour un champ qui affiche la fonction du participant).

Vous pouvez également ajouter des Paraphes.

A propos des champs « Image »

Vous pouvez demander à votre participant d’ajouter une image (par exemple, le logo d’une entreprise ou d’une entité) lors du parcours de signature. Pour ce faire, ajoutez un champ image et attribuez-le à un participant. L’image importée par le participant doit être au format JPEG ou PNG et sa taille ne doit pas dépasser 2 Mo.

Notez que vous ne pouvez pas ajouter de champs :

• sur un document qui a déjà été traité par un participant,
• sur un document qui contient déjà une signature (avant d’être importé dans la transaction).

Créer un champ de « Image »

Pour créer un champ « Saisie de texte », envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez image dans l’argument type.

Vous pouvez transmettre d’autres arguments optionnels :

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/fields \
-d type=image \
-d name=ImageField \
-d page=1 \
-d x=75 \
-d y=200 \
-d tooltip="Merci de rajouter le logo de votre entreprise ici."

• name : le nom du champ.
• page : le numéro de la page sur laquelle vous souhaitez positionner le champ.
• anchor : l’ancre PDF (chaîne de caractères dans le document) sous lequel le champ est automatiquement positionné.
• x : coordonnée horizontale du champ sur la page du document (en pixels).
• y : coordonnée verticale du champ sur la page du document (en pixels).
• copy_from : à utiliser pour copier le champ. La valeur attendue est l’identifiant du champ que vous souhaitez copier. Cela crée un nouveau champ sans position sur le document. Ne pas passer si vous passez l’argument move_from
• move_from : à utiliser pour déplacer un champ vers un autre document. La valeur attendue est l’identifiant du champ que vous souhaitez déplacer. Ne pas passer si vous passez l’argument copy_from.
• tooltip : l’instruction sur le texte que le participant doit ajouter au document lors du parcours de signature. L’instruction est limitée à 100 caractères.
• required : indique si le participant doit remplir le champ ou non. La valeur par défaut est true.

Pour plus d’informations sur le positionnement d’un champ à l’aide d’une ancre, consultez Créer un champ de signature avec une position.

L’API renvoie un sous-objet field.

{
  "id" : "fld_yXr",
  "name" : "ImageField",
  "type" : "image",
  "position" : {
    "page" : 2,
    "x" : 77,
    "y" : 400,
    "width" : 123,
    "height" : 95
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : false,
  "tooltip" : "Merci de rajouter le logo de votre entreprise ici.",
  "required" : true
}

Éditer un champ « Image »

Pour éditer un champ « Image », envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}.

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/fields/fld_DL4x \
-d type=image \
-d name=UpdatedImageField \
-d page=2 \
-d x=75 \
-d y=200 \ 
-d tooltip="Merci de rajouter le logo de votre entité ici." \
-d required=false

L’API renvoie un sous-objet field mis à jour.

{
  "id" : "fld_DL4x",
  "name" : "UpdatedImageField",
  "position" : {
    "page" : 2,
    "x" : 75,
    "y" : 200,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "tooltip" : "Merci de rajouter le logo de votre entité ici.",
  "required" : false,
  "font_size" : 12,
  "type" : "text"
}

---

Ajouter un champ Texte en lecture seule

← Précédent

Ajouter des cases à cocher

Suivant →