Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Les champs permettent de placer des données supplémentaires dans un document au moment de la signature. Comme les champs de signature, les champs de non-signature peuvent être placés n'importe où dans un document. Néanmoins, chaque champ est lié à une signature particulière. Seul le signataire de cette signature peut attribuer ou modifier la valeur du champ. Toutefois, une fois la signature apposée, la valeur du champ ne peut être modifiée par personne.
Vous ne pouvez pas ajouter de champs à ce qui suit : (1) les documents qui sont acceptés seulement; (2) le formulaire de consentement électronique; (3) les documents dans une transaction accessible.
Ajout d'un champ à un document
Pour ajouter un champ sur un document, vous devez d'abord créer votre objet Field en utilisant l'objet OneSpan Sign FieldBuilder. Le code suivant permet d'effectuer ce qui suit :
Field field = FieldBuilder.label() .withId(new FieldId("myLabelField")) .withValue("Example label field value") .atPosition(100, 200) .onPage(0) .build();
Ensuite, à l'aide du OneSpan Sign ApprovalService, ajoutez votre champ à votre document. Utilisez l'objet Field , PackageID, SignatureID et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
String labelFieldId = client.getApprovalService().addField(packageId, "sample-contract", signatureid, field);
Mise à jour d'un champ dans un document
Il est important de noter que lors de la mise à jour d'un champ, votre nouvel objet Champ doit avoir le même ID que le champ que vous voulez mettre à jour.
Le code suivant permet d'effectuer ce qui suit :
Field updatedField = FieldBuilder.signatureDate() .onPage(0) .withId(new FieldId("myLabelField")) .atPosition(100, 200) .build(); client.getApprovalService().updateField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), updatedField);
Suppression d'un champ dans un document
Pour supprimer un champ, utilisez le OneSpan Sign ApprovalService. Utilisez l'objet Field , PackageID, SignatureID et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.getApprovalService().deleteField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), new FieldId("myLabelField"));
Résultats
Une fois que vous aurez exécuté votre code, vos champs apparaîtront dans les documents de votre transaction.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Les champs permettent de placer des données supplémentaires dans un document au moment de la signature. Comme les champs de signature, les champs de non-signature peuvent être placés n'importe où dans un document. Néanmoins, chaque champ est lié à une signature particulière. Seul le signataire de cette signature peut attribuer ou modifier la valeur du champ. Toutefois, une fois la signature apposée, la valeur du champ ne peut être modifiée par personne.
Vous ne pouvez pas ajouter de champs à ce qui suit : (1) les documents qui sont acceptés seulement; (2) le formulaire de consentement électronique; (3) les documents dans une transaction accessible.
Ajout d'un champ à un document
Pour ajouter un champ dans un document, vous devez d'abord créer votre objet Champ à l'aide du Constructeur de champs de OneSpan Sign, comme indiqué ci-dessous.
Field field = FieldBuilder.Label() .WithId("myLabelField") .WithValue("Example label field value") .AtPosition(100, 200) .OnPage(0) .Build();
Ensuite, à l'aide du OneSpan Sign ApprovalService, ajoutez votre champ à votre document. Utilisez l'objet Field , PackageID, SignatureID et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
string labelFieldId = client.ApprovalService.AddField(packageId, "sample-contract", signatureid, field);
Mise à jour d'un champ dans un document
Il est important de noter que lors de la mise à jour d'un champ, votre nouvel objet Champ doit avoir le même ID que le champ que vous voulez mettre à jour.
Le code suivant permet d'effectuer ce qui suit :
Field updatedField = FieldBuilder.SignatureDate() .OnPage(0) .WithId("myLabelField") .AtPosition(100, 200) .Build(); client.ApprovalService.ModifyField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), updatedField);
Suppression d'un champ dans un document
Pour supprimer un champ, utilisez le OneSpan Sign ApprovalService. Utilisez l'objet Field , PackageID, SignatureID et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.ApprovalService.DeleteField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), "myLabelField");
Résultats
Une fois que vous aurez exécuté votre code, vos champs apparaîtront dans les documents de votre transaction.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Les champs permettent de placer des données supplémentaires dans un document au moment de la signature. Comme les champs de signature, les champs de non-signature peuvent être placés n'importe où dans un document. Néanmoins, chaque champ est lié à une signature particulière. Seul le signataire de cette signature peut attribuer ou modifier la valeur du champ. Toutefois, une fois la signature apposée, la valeur du champ ne peut être modifiée par personne.
Vous ne pouvez pas ajouter de champs à ce qui suit : (1) les documents qui sont acceptés seulement; (2) le formulaire de consentement électronique; (3) les documents dans une transaction accessible.
Ajout d'un champ à un document
L'exemple de demande ci-dessous vous montre comment ajouter un champ à un document existant :
Requête HTTP
POST /api/packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields
En-têtes HTTP
Accept: application/json; esl-api-version=11.21 Content-Type: application/json Authorization: Basic api_key
Données utiles de la demande
{ "name":"Signer Name", "top":500, "left":300, "width":100, "height":30, "page":0, "type":"INPUT", "value":null, "binding":"{signer.name}", "subtype":"LABEL" } Données utiles de la réponse
{ "binding": "{signer.name}", "validation": null, "id": "BsZv3XvmpsMH", "page": 0, "data": null, "subtype": "LABEL", "top": 500, "height": 30, "extractAnchor": null, "width": 100, "extract": false, "left": 300, "type": "INPUT", "value": "{signer.name}", "name": "Signer Name" } Mise à jour d'un champ dans un document
Il est important de noter que lors de la mise à jour d'un champ, votre nouvel objet Champ doit avoir le même ID que le champ que vous voulez mettre à jour.
Pour mettre à jour un champ, vous devrez faire une demande PUT à :
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/fields/{fieldId} Avec les paramètres de champ mis à jour :
{ "id": "myLabelField", "top": 200, "left": 100, "width": 250, "height": 50, "page": 0, "type": "INPUT", "binding": "{approval.signed}", "subtype": "LABEL" } Suppression d'un champ dans un document
Pour supprimer un champ, il suffit d'envoyer une demande SUPPRIMER à l'adresse suivante :
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/fields/{fieldId} Résultats
Une fois que vous aurez exécuté votre code, vos champs apparaîtront dans les documents de votre transaction.
Champs de construction de formulaires
Les éléments suivants décrivent les paramètres et le code JSON pouvant être utilisés pour ajouter des champs à un document.
Champs de signature
| Champ | Utilisation | JSON |
|---|---|---|
| Signature
| Utilisée pour recueillir la signature d'un destinataire. | {
"type": "SIGNATURE",
"subtype": "FULLNAME",
"id": "signer1_signature1",
"name": "signer1_signature1",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 357.5083117443869,
"page": 0
}
|
Champs de saisie
| Champ | Utilisation | JSON |
|---|---|---|
| Champ de texte | Ce champ accepte tout texte saisi par le signataire avant la signature. | {
"type": "INPUT",
"subtype": "TEXTFIELD",
"id": "signer1_textfield1",
"name": "signer1_textfield1",
"validation": {
"required": false,
"maxLength": null,
"errorMessage": "",
"minLength": null,
"pattern": ""
},
"value": "default value",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 425,
"page": 0
} |
| Zone de texte | Il s'agit d'une zone de plusieurs lignes qui accepte tout texte saisi par le signataire avant la signature. | {
"type": "INPUT",
"subtype": "TEXTAREA",
"id": "signer1_textarea1",
"name": "signer1_textarea1",
"validation": {
"required": false,
"maxLength": null,
"errorMessage": "",
"minLength": null,
"pattern": ""
},
"value": "line1\nline2\nline3",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 476,
"page": 0
}
|
| Case (avec groupe de cases à cocher) | Il s'agit d'une case que le signataire peut cocher ou décocher. Utilisez des cases lorsque vous voulez permettre aux signataires de choisir plus d'une option dans une liste. Utilisez le groupe de cases pour placer les cases à cocher sélectionnées dans un groupe de cases associées. Si l'expéditeur définit l'une des cases d'un groupe comme obligatoire, le signataire doit sélectionner au moins un membre du groupe pendant la signature. | {
"type": "INPUT",
"subtype": "CHECKBOX",
"id": "signer1_checkbox1",
"name": "signer1_checkbox1",
"validation": {
"required": false,
"group": "CheckboxGroup1",
"minimumRequired": 1,
"maximumRequired": null
},
"value": "X",
"tooltip": "field tooltip",
"width": 20,
"height": 20,
"left": 453,
"top": 789,
"page": 0
}
|
| Case (sans groupe de cases à cocher) |
| {
"type": "INPUT",
"subtype": "CHECKBOX",
"id": "signer1_checkbox2",
"name": "signer1_checkbox2",
"value": "X",
"tooltip": "field tooltip",
"width": 20,
"height": 20,
"left": 453,
"top": 789,
"page": 0
}
|
| Radio | Les boutons radio permettent aux signataires de sélectionner l'une des nombreuses options prédéfinies. Utilisez des boutons radio lorsque vous voulez que les signataires ne choisissent qu'une seule option. Utilisez le groupe de radio pour placer les boutons radio sélectionnés dans un groupe de boutons associés. Vous pouvez identifier un bouton du groupe comme étant le bouton par défaut, ce qui garantit qu'il sera présélectionné. | {
"type": "INPUT",
"subtype": "RADIO",
"id": "signer1_radio1",
"name": "signer1_radio1",
"validation": {
"required": true,
"enum": [
"RadioGroup1"
]
},
"value": "X",
"tooltip": "field tooltip",
"width": 18.0,
"height": 18.0,
"left": 389.0,
"top": 785.0,
"page": 0
}
}
|
| Liste | Il s'agit d'une liste déroulante proposant plusieurs options prédéfinies aux destinataires. Le signataire peut choisir une option dans la liste. Une fois cette option sélectionnée, seule cette option est affichée, ce qui minimise l'espace que cet élément occupe à l'écran. | {
"type": "INPUT",
"subtype": "LIST",
"id": "signer1_list1",
"name": "signer1_list1",
"validation": {
"required": false,
"enum": [
"option1",
"option2",
"option3"
]
},
"value": "option1",
"tooltip": "field tooltip",
"width": 249.0,
"height": 55.0,
"left": 274.0,
"top": 813.0,
"page": 0
}
|
| Étiquette | Il s'agit d'une étiquette en lecture seule qui sera apposée sur le PDF. | {
"type": "INPUT",
"subtype": "LABEL",
"id": "signer1_label1",
"name": "signer1_label1",
"value": "label value",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 626,
"page": 0
}
|
Champs de liaison
| Champ | Utilisation | JSON |
|---|---|---|
| Date de signature
| Ce champ automatique estampille le document avec la date et l'heure de la signature. | {
"type": "INPUT",
"subtype": "LABEL",
"id": "signer1_signingdate1",
"name": "signer1_signingdate1",
"binding": "{approval.signed}",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 357.5083117443869,
"page": 0
}
|
| Nom du signataire
| Ce champ automatique estampille le document avec le nom du signataire tel qu'il a été saisi sur la transaction. | {
"type": "INPUT",
"subtype": "LABEL",
"id": "signer1_signername",
"name": "signer1_signername",
"binding": "{signer.name}",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 562,
"page": 0
}
|
| Titre du signataire | Ce champ automatique estampille le document avec le titre du signataire tel qu'il a été saisi sur la transaction. | {
"type": "INPUT",
"subtype": "LABEL",
"id": "signer1_signertitle",
"name": "signer1_signertitle",
"binding": "{signer.title}",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 613,
"page": 0
}
|
| Entreprise du signataire | Ce champ automatique estampille le document avec le nom de la société du signataire tel qu'il a été saisi sur la transaction. | {
"type": "INPUT",
"subtype": "LABEL",
"id": "signer1_signercompany",
"name": "signer1_signercompany",
"binding": "{signer.company}",
"width": 185.5958549222798,
"height": 41.24352331606218,
"left": 305.2020725388601,
"top": 664,
"page": 0
}
|
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Les champs permettent de placer des données supplémentaires dans un document au moment de la signature. Comme les champs de signature, les champs de non-signature peuvent être placés n'importe où dans un document. Néanmoins, chaque champ est lié à une signature particulière. Seul le signataire de cette signature peut attribuer ou modifier la valeur du champ. Toutefois, une fois la signature apposée, la valeur du champ ne peut être modifiée par personne.
Vous ne pouvez pas ajouter de champs à ce qui suit : (1) les documents qui sont acceptés seulement; (2) le formulaire de consentement électronique; (3) les documents dans une transaction accessible.
Ajout d'un champ à un document
Pour ajouter un champ dans un document, vous devez d'abord construire votre objet Champ comme indiqué ci-dessous.
//create field to an existing approval ESignLiveAPIObjects.Field label_field = new ESignLiveAPIObjects.Field(); label_field.id = 'label_field'; label_field.type = 'INPUT'; label_field.subtype = 'LABEL'; label_field.value = 'old label value'; label_field.page = 0; label_field.top = 100.0; label_field.left = 50.0; label_field.width = 150.0; label_field.height = 50.0;
Puis, à l'aide de la fonction addField ajoutez votre champ à votre document. Utilisez l'objet Field , PackageID, ApprovalID, et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
//String packageId, String documentId, String approvalId, ESignLiveAPIObjects.Field fieldToCreate String label_field_response = sdk.addField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field); label_field = (ESignLiveAPIObjects.Field)JSON.deserialize(label_field_response, ESignLiveAPIObjects.Field.class);
Mise à jour d'un champ dans un document
Il est important de noter que lors de la mise à jour d'un champ, votre nouvel objet Champ doit avoir le même ID que le champ que vous voulez mettre à jour.
Le code suivant permet d'effectuer ce qui suit :
//update field //String packageId, String documentId, String approvalId, String fieldId, ESignLiveAPIObjects.Field fieldToUpdate label_field.value = 'changed label value'; sdk.updateField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field.id,label_field);
Suppression d'un champ dans un document
Pour supprimer un champ, utilisez le OneSpan Sign ApprovalService. Utilisez l'objet Field , PackageID, SignatureID et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
//delete field //String packageId, String documentId, String approvalId, String fieldId sdk.deleteField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field.id);
Résultats
Une fois que vous aurez exécuté votre code, vos champs apparaîtront dans les documents de votre transaction.