Ajouter un champ saisie de texte

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 saisie 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 « Saisie de texte »

Un champ « Saisie de texte » est un champ vide qui doit être rempli par le participant lors du parcours de signature.

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 « Saisie de texte »

Pour créer un champ « Saisie de texte », envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez text 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=text \
-d name=TextField \
-d page=1 \
-d x=75 \
-d y=200 \
-d tooltip="Merci de renseigner votre numéro de sécurité sociale ici." \
-d value="123456789"

• 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.
• height : la hauteur du champ (exprimée en unités d’espace utilisateur par défaut du PDF). Si elle n’est pas fournie, la hauteur est définie sur la hauteur de la police.
• width : la largeur du champ (exprimée en unités d’espace utilisateur par défaut du PDF). La valeur par défaut est 200.
• 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.
• value : valeur par défaut du champ, suggérée par le créateur de la transaction. Le participant peut la conserver ou la modifier lors du parcours de signature. Le nombre maximum de caractères dépend des dimensions du champ.

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_DL4x",
  "name" : "TextField",
  "position" : {
    "page" : 1,
    "x" : 75,
    "y" : 200,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "tooltip" : "Merci de renseigner votre numéro de sécurité sociale ici.",
  "required" : true,
  "font_size" : 12,
  "type" : "text",
  "value": "123456789",
}

Éditer un champ « Saisie de texte »

Pour éditer un champ « Saisie de texte », 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=text \
-d name=UpdatedTextField \
-d page=2 \
-d x=75 \
-d y=200 \
-d tooltip="Merci de renseigner plus d'informations ici."

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

{
  "id" : "fld_DL4x",
  "name" : "UpdatedTextField",
  "position" : {
    "page" : 2,
    "x" : 75,
    "y" : 200,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "tooltip" : "Merci de renseigner plus d'informations ici.",
  "required" : true,
  "font_size" : 12,
  "type" : "text",
  "value": "123456789",
}

---

Ajouter un champ automatique Fonction

← Précédent

Ajouter un champ Texte en lecture seule

Suivant →