- 18 Nov 2024
- 8 Minutes à lire
- SombreLumière
- PDF
Ajout de signatures
- Mis à jour le 18 Nov 2024
- 8 Minutes à lire
- SombreLumière
- PDF
Java SDK.NET SDKREST APIAPEX SDK
Java SDK
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Ajout d’une signature à un document
Pour ajouter une signature à un document, vous devez d’abord créer votre objet Signature à l’aide du OneSpan Sign SignatureBuilder. Pour ce faire, le code suivant :
// Fullname signature style
Signature signature1 = SignatureBuilder.signatureFor("john.smith@example.com")
.onPage(0)
.atPosition(215, 510)
.withSize(200, 50)
.withId(new SignatureId("signature1"))
.build();
// Handwritten signature style
Signature signature2 = SignatureBuilder.captureFor("john.smith@example.com")
.onPage(0)
.atPosition(215, 510)
.withSize(200, 50)
.withId(new SignatureId("signature2"))
.build();
// Initials signature style
Signature signature3 = SignatureBuilder.initialsFor("john.smith@example.com")
.onPage(0)
.atPosition(215, 510)
.withSize(200, 50)
.withId(new SignatureId("signature3"))
.build();
DocumentPackage createdPackage = client.getPackageService().getPackage(packageId);
Une fois que vous avez créé votre objet Signature , récupérez votre transaction à l’aide du client OneSpan Sign. Ensuite, à l’aide du service d’approbation de signature OneSpan, ajoutez votre signature à votre document. Utilisez les objets DocumentPackage, Signature et documentID comme paramètres. Pour ce faire, le code suivant :
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. Pour ce faire, le code suivant :
Signature updatedSignature = SignatureBuilder.captureFor("john.smith@example.com")
.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);
Lors de la mise à jour d’une signature, votre nouvel objet Signature doit avoir le même ID que la signature que vous souhaitez mettre à jour.
Suppression d’une signature d’un document
La suppression d’une signature d’un document se fait à l’aide du service d’approbation OneSpan Sign. Utilisez les paramètres PackageID, SignatureID et documentID . Pour ce faire, le code suivant :
client.getApprovalService().deleteSignature(packageId, documentId, new SignatureId("signature1"));
Résultats
Une fois que vous avez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.
Kit de développement logiciel (SDK) .NET
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Ajout d’une signature à un document
Pour ajouter une signature à un document, vous devez d’abord créer votre objet Signature à l’aide du OneSpan Sign SignatureBuilder. Pour ce faire, le code suivant :
// Fullname signature style
Signature signature1 = SignatureBuilder.SignatureFor("john.smith@example.com")
.OnPage(0)
.AtPosition(215, 510)
.WithSize(200, 50)
.WithId(new SignatureId("signature1"))
.Build();
// Handwritten signature style
Signature signature2 = SignatureBuilder.CaptureFor("john.smith@example.com")
.OnPage(0)
.AtPosition(215, 510)
.WithSize(200, 50)
.WithId(new SignatureId("signature2"))
.Build();
// Initials signature style
Signature signature3 = SignatureBuilder.InitialsFor("john.smith@example.com")
.OnPage(0)
.AtPosition(215, 510)
.WithSize(200, 50)
.WithId(new SignatureId("signature3"))
.Build();
DocumentPackage createdPackage = client.GetPackage(packageId);
Une fois que vous avez créé votre objet Signature , récupérez votre transaction à l’aide du client OneSpan Sign. Ensuite, à l’aide du service d’approbation de signature OneSpan, ajoutez votre signature à votre document. Utilisez les objets DocumentPackage, Signature et documentID comme paramètres. Pour ce faire, le code suivant :
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. Pour ce faire, le code suivant :
Signature updatedSignature = SignatureBuilder
.CaptureFor("john.smith@example.com")
.OnPage(0)
.AtPosition(215, 510)
.WithSize(300, 50)
.WithId(new SignatureId("signature1"))
.Build();
IList<Signature> signatures = new List<Signature>();
signatures.Add(updatedSignature);
DocumentPackage updatedPackage = client.GetPackage(packageId);
client.ApprovalService.UpdateApprovals(updatedPackage, documentId, signatures);
Lors de la mise à jour d’une signature, votre nouvel objet Signature doit avoir le même ID que la signature que vous souhaitez mettre à jour.
Suppression d’une signature d’un document
La suppression d’une signature d’un document se fait à l’aide du service d’approbation OneSpan Sign. Utilisez les paramètres PackageID, SignatureID et documentID . Pour ce faire, le code suivant :
Signature updatedSignature = SignatureBuilder
.CaptureFor("john.smith@example.com")
.OnPage(0)
.AtPosition(215, 510)
.WithSize(300, 50)
.WithId(new SignatureId("signature1"))
.Build();
IList<Signature> signatures = new List<Signature>();
signatures.Add(updatedSignature);
DocumentPackage updatedPackage = client.GetPackage(packageId);
client.ApprovalService.UpdateApprovals(updatedPackage, documentId, signatures);
// Deleting the approval
client.ApprovalService.DeleteApproval(packageId, documentId, "signature1");
Résultats
Une fois que vous avez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.
REST API
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Ajout d’une signature à un document
Pour ajouter une signature à un document, vous devez d’abord modifier l’objet fields . Pour ce faire, le code suivant :
Requête HTTP
POST /api/packages/{packageId}/documents/{documentId}/approvals
En-têtes HTTP
Accept: application/json
Content-Type: application/json
Charge utile 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, consultez le tableau Charge utile de la demande ci-dessous.
Charge utile de 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 devrez effectuer une requête PUT à l’adresse suivante :
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"
}
]
}
Lors de la mise à jour d’une signature, votre nouvel objet Signature doit avoir le même ID que la signature que vous souhaitez mettre à jour.
Suppression d’une signature d’un document
Enfin, la suppression d’une signature se fait en faisant une requête DELETE à :
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/
Résultats
Une fois que vous avez 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 | Obligatoire | Faire défaut | Exemples de valeurs |
---|---|---|---|---|---|
rôle | corde | Oui | Non | n/a | Signataire1 |
id | corde | Oui | Non | n/a | Signature1 |
champs | |||||
Retour au début | 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 | corde | Oui | Non | n/a | SIGNATURE / SAISIE |
Sous-type | corde | Oui | Non | n/a | NOM COMPLET / INITIALES / CAPTURE / MOBILE_CAPTURE / ÉTIQUETTE / CHAMP DE TEXTE / ZONE DE TEXTE / CASE À COCHER / DATE / RADIO / LISTE |
APEX SDK
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Ajout d’une signature à un document
Pour ajouter une signature à un document, vous devez d’abord créer votre objet Approbation. Pour ce faire, le code suivant :
// #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 créé votre objet Signature , utilisez le client SDK OneSpan Sign pour ajouter votre signature à votre document. Utilisez PackageID, l’objet Signature et documentID comme paramètres. Pour ce faire, le code suivant :
ESignLiveSDK sdk = new ESignLiveSDK(); //String packageId, String documentId,ESignLiveAPIObjects.Approval approval sdk.addSignature(packageId, documentId, approval_fullname); sdk.addSignature(packageId, documentId, approval_capture);
Mise à jour d’une signature sur un document
Vous pouvez mettre à jour une signature qui a déjà été associée à un document. Pour ce faire, le code suivant :
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);
Lors de la mise à jour d’une signature, votre nouvel objet Signature doit avoir le même ID que la signature que vous souhaitez mettre à jour.
Suppression d’une signature d’un document
La suppression d’une signature d’un document se fait à l’aide du client SDK OneSpan Sign. Utilisez les paramètres PackageID, ApprovalID et documentID . Pour ce faire, le code suivant :
// #4. Delete signature
sdk.deleteApproval(packageId, documentId, 'approval_fullname');
Résultats
Une fois que vous avez exécuté votre code, vos signatures apparaîtront dans les documents de votre transaction.