Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Ajout d'une signature à un document
Pour ajouter une signature à un document, vous devrez d'abord créer votre objet Signature en utilisant le OneSpan Sign SignatureBuilder. Le code suivant permet d'effectuer ce qui suit :
//Fullname signature style Signature signature1 = SignatureBuilder.signatureFor("[email protected]") .onPage(0) .atPosition(215, 510) .withSize(200, 50) .withId(new SignatureId("signature1")) .build(); //Handwritten signature style Signature signature2 = SignatureBuilder.captureFor("[email protected]") .onPage(0) .atPosition(215, 510) .withSize(200, 50) .withId(new SignatureId("signature2")) .build(); //Initials signature style Signature signature3 = SignatureBuilder.initialsFor("[email protected]") .onPage(0) .atPosition(215, 510) .withSize(200, 50) .withId(new SignatureId("signature3")) .build(); DocumentPackage createdPackage = client.getPackageService().getPackage(packageId);
Une fois que vous aurez construit votre objet Signature , récupérez votre transaction en utilisant le client OneSpan Sign. Puis, à l'aide du OneSpan Sign ApprovalService, ajoutez votre signature à votre document. Utilisez le DocumentPackage, la Signature et l'documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.getApprovalService().addSignature(createdPackage, documentId, signature1);
Mise à jour d'une signature sur un document
Vous pouvez mettre à jour une signature qui a déjà été associée à un document. Le code suivant permet d'effectuer ce qui suit :
Signature updatedSignature = SignatureBuilder.captureFor("[email protected]") .onPage(0) .atPosition(215, 510) .withSize(300, 50) .withId(new SignatureId("signature1")) .build(); List<Signature> signatures = new ArrayList(); signatures.add(updatedSignature); DocumentPackage updatedPackage = client.getPackageService().getPackage(packageId); client.getApprovalService().updateSignatures(updatedPackage, documentId, signatures);
Lorsque vous mettez à jour une signature, votre nouvelle Signature doit avoir le même identifiant que la signature que vous voulez mettre à jour.
Suppression d'une signature dans un document
La suppression d'une signature d'un document se fait à l'aide de la fonction OneSpan Sign ApprovalService. Utilisez l'PackageID, SignatureID et l'documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.getApprovalService().deleteSignature(packageId, documentId, new SignatureId("signature1"));
Résultats
Une fois que vous aurez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Ajout d'une signature à un document
Pour ajouter une signature à un document, vous devrez d'abord créer votre objet Signature en utilisant le OneSpan Sign SignatureBuilder. Le code suivant permet d'effectuer ce qui suit :
//Fullname signature style Signature signature1 = SignatureBuilder.SignatureFor("[email protected]") .OnPage(0) .AtPosition(215, 510) .WithSize(200, 50) .WithId(new SignatureId("signature1")) .Build(); //Handwritten signature style Signature signature2 = SignatureBuilder.CaptureFor("[email protected]") .OnPage(0) .AtPosition(215, 510) .WithSize(200, 50) .WithId(new SignatureId("signature2")) .Build(); //Initials signature style Signature signature3 = SignatureBuilder.InitialsFor("[email protected]") .OnPage(0) .AtPosition(215, 510) .WithSize(200, 50) .WithId(new SignatureId("signature3")) .Build(); DocumentPackage createdPackage = client.GetPackage(packageId);
Une fois que vous aurez construit votre objet Signature , récupérez votre transaction en utilisant le client OneSpan Sign. Puis, à l'aide du OneSpan Sign ApprovalService, ajoutez votre signature à votre document. Utilisez le DocumentPackage, la Signature et l'documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.ApprovalService.AddApproval(createdPackage, documentId, signature1);
Mise à jour d'une signature sur un document
Vous pouvez mettre à jour une signature qui a déjà été associée à un document. Le code suivant permet d'effectuer ce qui suit :
Signature updatedSignature = SignatureBuilder.CaptureFor("[email protected]") .OnPage(0) .AtPosition(215, 510) .WithSize(300, 50) .WithId(new SignatureId("signature1")) .Build(); IList<Signature> signatures = new List(); signatures.Add(updatedSignature); DocumentPackage updatedPackage = client.GetPackage(packageId); client.ApprovalService.UpdateApprovals(updatedPackage, documentId, signatures);
Lorsque vous mettez à jour une signature, votre nouvelle Signature doit avoir le même identifiant que la signature que vous voulez mettre à jour.
Suppression d'une signature dans un document
La suppression d'une signature d'un document se fait à l'aide de la fonction OneSpan Sign ApprovalService. Utilisez l'PackageID, SignatureID et l'documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
client.ApprovalService.DeleteApproval(packageId, documentId, "signature1");
Résultats
Une fois que vous aurez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Ajout d'une signature à un document
Pour ajouter une signature à un document, vous devez d'abord éditer l'objet fields. Le code suivant permet d'effectuer ce qui suit :
Requête HTTP
POST /api/packages/{packageId}/documents/{documentId}/approvals
En-têtes HTTP
Accept: application/json Content-Type: application/json Authorization: Basic api_key
Données utiles de la demande
{ "role": "Signer1", "id": "signature1", "fields": [ { "top": 510, "left": 215, "width": 200, "height": 50, "page": 0, "type": "SIGNATURE", "subtype": "FULLNAME" } ] } { "role": "Signer1", "id": "signature1", "fields": [ { "top": 510, "left": 215, "width": 200, "height": 50, "page": 0, "type": "SIGNATURE", "subtype": "CAPTURE" } ] } { "role": "Signer1", "id": "signature1", "fields": [ { "top": 510, "left": 215, "width": 200, "height": 50, "page": 0, "type": "SIGNATURE", "subtype": "INITIALS" } ] }
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
{ "signed": null, "role": "Signer1", "accepted": null, "id": "signature1", "data": null, "fields": [ { "top": 50, "left": 300, "height": 50, "page": 0, "type": "SIGNATURE", "validation": null, "binding": null, "width": 200, "subtype": "FULLNAME", "extract": false, "extractAnchor": null, "id": "tx1qz7485780", "data": null, "value": "", "name": "" } ], "name": "" } Mise à jour d'une signature sur un document
Vous pouvez mettre à jour une signature qui a déjà été associée à un document. Pour mettre à jour une signature, vous devez faire une PUT demande auprès de :
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/ Avec les paramètres de signature mis à jour :
{ "role": "Signer1", "fields": [ { "top": 510, "left": 215, "width": 300, "height": 50, "id": "signature1", "page": 0, "type": "SIGNATURE", "subtype": "CAPTURE" } ] } Lorsque vous mettez à jour une signature, votre nouvelle Signature doit avoir le même identifiant que la signature que vous voulez mettre à jour.
Suppression d'une signature dans un document
Enfin, la suppression d'une signature se fait en faisant une demande DELETE à :
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/ Résultats
Une fois que vous aurez exécuté votre code, vos signatures 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 |
|---|---|---|---|---|---|
| rôle | chaîne de caractères | Oui | Non | s.o. | Signataire1 |
| id | chaîne de caractères | Oui | Non | s.o. | signature1 |
| champs | |||||
| haut | entier | Oui | Non | 0 | 510 |
| gauche | entier | Oui | Non | 0 | 215 |
| largeur | entier | Oui | Non | 200 | 200 |
| hauteur | entier | Oui | Non | 50 | 50 |
| page | entier | Oui | Non | 0 | 0 |
| type | chaîne de caractères | Oui | Non | s.o. | SIGNATURE / ENTRÉE |
| sous-type | chaîne de caractères | Oui | Non | s.o. | NOM COMPLET / INITIALES / CAPTURE / CAPTURE_MOBILE / ÉTIQUETTE / CHAMP DE TEXTE / ZONE DE TEXTE / CASE / DATE / RADIO / LISTE |
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Ajout d'une signature à un document
Pour ajouter une signature à un document, vous devez d'abord créer votre objet Approval. Le code suivant permet d'effectuer ce qui suit :
//#1. Add signature //Fullname signature style ESignLiveAPIObjects.Field field_fullname = new ESignLiveAPIObjects.Field(); field_fullname.id = 'field_fullname'; field_fullname.type = 'SIGNATURE'; field_fullname.subtype = 'FULLNAME'; field_fullname.page = 0; field_fullname.top = 100.0; field_fullname.left = 50.0; field_fullname.width = 150.0; field_fullname.height = 50.0; ESignLiveAPIObjects.Approval approval_fullname = new ESignLiveAPIObjects.Approval(); approval_fullname.fields = new List<ESignLiveAPIObjects.Field>{field_fullname}; approval_fullname.id = 'approval_fullname'; approval_fullname.role = roleId; //Capture signature style ESignLiveAPIObjects.Field field_capture = new ESignLiveAPIObjects.Field(); field_capture.id = 'field_capture'; field_capture.type = 'SIGNATURE'; field_capture.subtype = 'CAPTURE'; field_capture.page = 0; field_capture.top = 200.0; field_capture.left = 50.0; field_capture.width = 150.0; field_capture.height = 50.0; ESignLiveAPIObjects.Approval approval_capture = new ESignLiveAPIObjects.Approval(); approval_capture.fields = new List<ESignLiveAPIObjects.Field>{field_capture}; approval_capture.id = 'approval_capture'; approval_capture.role = roleId; //Initials signature style ESignLiveAPIObjects.Field field_initials = new ESignLiveAPIObjects.Field(); field_initials.id = 'field_initials'; field_initials.type = 'SIGNATURE'; field_initials.subtype = 'INITIALS'; field_initials.page = 0; field_initials.top = 300.0; field_initials.left = 50.0; field_initials.width = 150.0; field_initials.height = 50.0; ESignLiveAPIObjects.Approval approval_initials = new ESignLiveAPIObjects.Approval(); approval_initials.fields = new List<ESignLiveAPIObjects.Field>{field_initials}; approval_initials.id = 'approval_initials'; approval_initials.role = roleId;
Une fois que vous avez construit votre objet Signature , utilisez le client SDK OneSpan Sign pour ajouter votre signature à votre document. Utilisez les PackageID, Signature et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
ESignLiveSDK sdk = new ESignLiveSDK(); //String packageId, String documentId,ESignLiveAPIObjects.Approval approval sdk.addSignature(packageId, documentId, approval_fullname); sdk.addSignature(packageId, documentId, approval_capture); sdk.addSignature(packageId, documentId, approval_initials);
Mise à jour d'une signature sur un document
Vous pouvez mettre à jour une signature qui a déjà été associée à un document. Le code suivant permet d'effectuer ce qui suit :
//#2. update single signature ESignLiveAPIObjects.Field label_field_fullname = new ESignLiveAPIObjects.Field(); label_field_fullname.id = 'label_field_fullname'; label_field_fullname.type = 'INPUT'; label_field_fullname.subtype = 'LABEL'; label_field_fullname.value = 'label value fullname'; label_field_fullname.page = 0; label_field_fullname.top = 100.0; label_field_fullname.left = 250.0; label_field_fullname.width = 150.0; label_field_fullname.height = 50.0; approval_fullname.fields.add(label_field_fullname); //String packageId, String documentId, String approvalId, ESignLiveAPIObjects.Approval approval sdk.updateApproval(packageId, documentId, 'approval_fullname', approval_fullname);
Lorsque vous mettez à jour une signature, votre nouvelle Signature doit avoir le même identifiant que la signature que vous voulez mettre à jour.
Suppression d'une signature dans un document
La suppression d'une signature d'un document se fait à l'aide du client SDK OneSpan Sign. Utilisez les PackageID, ApprovalID, et documentID comme paramètres. Le code suivant permet d'effectuer ce qui suit :
//#4. delete signature sdk.deleteApproval(packageId, documentId, 'approval_fullname');
Résultats
Une fois que vous aurez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.