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" }
Pour une description complète de chaque champ, voir le tableau des données utiles de la demande ci-dessous.
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" } Reportez-vous à la note de publication 10.6.1 pour connaître le motif du transport de esl-api-version dans l'en-tête de la demande. Si vous voulez un exemple de création d'un paquet de documents de base pour comparaison, vous pouvez suivre ce guide.
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.
Tableau des données utiles de la demande
| Propriété | Type | Modifiable | Requis | Par défaut | Exemples de valeurs |
|---|---|---|---|---|---|
| nom | chaîne de caractères | Oui | Non | s.o. | Nom du signataire |
| haut | entier | Oui | Non | 0 | 500 |
| gauche | entier | Oui | Non | 0 | 300 |
| largeur | entier | Oui | Non | 200 | 100 |
| hauteur | entier | Oui | Non | 50 | 30 |
| page | entier | Oui | Non | 0 | 0 / 1 / 2 ... |
| type | chaîne de caractères | Oui | Non | s.o. | SIGNATURE / ENTRÉE |
| valeur | chaîne de caractères | Oui | Non | nul | BANQUE STU |
| sous-type | chaîne de caractères | Oui | Non | s.o. | NOM COMPLET / INITIALES / CAPTURE / ÉTIQUETTE / CHAMP DE TEXTE / ZONE DE TEXTE / CASE / RADIO / LISTE |
| liaison | chaîne de caractères | Oui | Non | nul | {approval.signed} / {signer.title} / {signer.name} / {signer.company} |
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.