Gestion des espaces réservés de signature
  • 21 Nov 2024
  • 5 Minutes à lire
  • Sombre
    Lumière
  • PDF

Gestion des espaces réservés de signature

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

Un espace réservé à la signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un espace réservé peut être attribué à un champ de signature comme si vous affectiez un signataire régulier. Cependant, tous les espaces réservés doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Étant donné qu’un espace réservé à la signature n’a pas d’adresse e-mail, il est identifié par un identifiant.

Ajout d’un espace réservé de signature à un modèle

Pour ajouter un espace réservé de signature à un modèle, vous devez d’abord créer l’objet Placeholder . Le code suivant créera un objet Placeholder :

Placeholder placeholder = new Placeholder("Manager");

Une fois l’objet Placeholder créé, utilisez OneSpan Sign TemplateService pour ajouter votre espace réservé de signature à votre modèle et transmettez templateId et placeholder en tant que paramètres. Pour ce faire, le code suivant :

 Placeholder addedPlaceholder = eslClient.getTemplateService().addPlaceholder(templateId, placeholder); 

Mise à jour d’un espace réservé de signature

Pour mettre à jour un espace réservé de signature existant, utilisez le code suivant :

addedPlaceholder.setName("Client");
Placeholder updatedPlaceholder = eslClient.getTemplateService().updatePlaceholder(templateId, addedPlaceholder);

Suppression d’un espace réservé à la signature

Enfin, la suppression d’un espace réservé à la signature s’effectue à l’aide du PackageService. Vous devrez passer l’objet templateId et l’espace réservé id String en tant que paramètres.

eslClient.getPackageService().removeSigner(templateId, addedPlaceholder.getId());

Kit de développement logiciel (SDK) .NET

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

Un espace réservé à la signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un espace réservé peut être attribué à un champ de signature comme si vous affectiez un signataire régulier. Cependant, tous les espaces réservés doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Étant donné qu’un espace réservé à la signature n’a pas d’adresse e-mail, il est identifié par un identifiant.

Ajout d’un espace réservé de signature à un modèle

Pour ajouter un espace réservé de signature à un modèle, vous devez d’abord créer l’objet Placeholder . Le code suivant créera un objet Placeholder :

 Placeholder placeholder = new Placeholder("Manager"); 

Une fois l’objet Placeholder créé, utilisez OneSpan Sign TemplateService pour ajouter votre espace réservé de signature à votre modèle et transmettez templateId et placeholder en tant que paramètres. Pour ce faire, le code suivant :

 Placeholder addedPlaceholder = eslClient.TemplateService.AddPlaceholder(templateId, placeholder); 

Mise à jour d’un espace réservé de signature

Pour mettre à jour un espace réservé de signature existant, utilisez le code suivant :

addedPlaceholder.Name = "Client";
Placeholder updatedPlaceholder = eslClient.TemplateService.UpdatePlaceholder(templateId, addedPlaceholder);

Suppression d’un espace réservé à la signature

Enfin, la suppression d’un espace réservé à la signature s’effectue à l’aide du PackageService. Vous devrez passer l’objet templateId et l’espace réservé id String en tant que paramètres.

eslClient.PackageService.RemoveSigner(templateId, addedPlaceholder.Id);

REST API

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

Un espace réservé à la signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un espace réservé peut être attribué à un champ de signature comme si vous affectiez un signataire régulier. Cependant, tous les espaces réservés doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Étant donné qu’un espace réservé à la signature n’a pas d’adresse e-mail, il est identifié par un identifiant.

Ajout d’un espace réservé à un modèle

Pour ajouter un espace réservé de signature à un modèle, utilisez le code suivant :

Requête HTTP

POST /api/packages/{templateId}/roles

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   

Charge utile de la demande

 {   "id": "Manager",   "type": "SIGNER",   "index": 0,   "name": "Manager"   

Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.

Charge utile de réponse

{
    "id": "Manager",
    "type": "SIGNER",
    "index": 0,
    "name": "Manager"
}

Mise à jour d’un espace réservé de signature

La mise à jour d’un espace réservé se fait également de la même manière. Vous devrez générer le JSON avec les mises à jour que vous souhaitez effectuer :

Requête HTTP

PUT /api/packages/{templateId}/roles/[roleId}

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   

Charge utile de la demande

{
    "id": "Manager",
    "type": "SIGNER",
    "index": 0,
    "name": "Manager"
}

Charge utile de réponse

{
    "id": "Manager",
    "data": null,
    "emailMessage": null,
    "attachmentRequirements": [],
    "locked": false,
    "reassign": false,
    "specialTypes": [],
    "type": "SIGNER",
    "index": 0,
    "signers": [],
    "name": "Manager"
}

Suppression d’un espace réservé à la signature

Enfin, pour supprimer un espace réservé :

Requête HTTP

DELETE /api/packages/{templateId}/roles/{roleId}

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   

Tableau des données utiles de la demande

Propriété

Type

Modifiable

Obligatoire

Faire défaut

Exemples de valeurs

nom

corde

Oui

Non

n/a

Gérant

id

corde

Oui

Non

n/a

Gérant

type

Stringer

Oui

Non

SIGNATAIRE

SIGNATAIRE / EXPÉDITEUR

nom

corde

Oui

Non

n/a

Gérant

APEX SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

Un espace réservé à la signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un espace réservé peut être attribué à un champ de signature comme si vous affectiez un signataire régulier. Cependant, tous les espaces réservés doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Étant donné qu’un espace réservé à la signature n’a pas d’adresse e-mail, il est identifié par un identifiant.

Ajout d’un espace réservé de signature à un modèle

Pour ajouter un espace réservé dans un modèle, vous devez d’abord créer votre objet Role . Pour ce faire, le code suivant :

String placeholderId = 'placeholder1';
ESignLiveAPIObjects.Role placeholder1 = new ESignLiveAPIObjects.Role();
placeholder1.id = placeholderId;
placeholder1.name = placeholderId;

Une fois que vous avez créé votre objet Placeholder , utilisez le sdk.helper pour ajouter votre espace réservé de signature à votre modèle et transmettez templateId et placeholder en tant que paramètres. Pour ce faire, le code suivant :

sdk.helper.createRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=', placeholder1);

Mise à jour d’un espace réservé de signature

Pour mettre à jour un espace réservé de signature existant, utilisez le code suivant :

sdk.helper.updateRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=','Manager', placeholder1); 

Suppression d’un espace réservé à la signature

Enfin, la suppression d’un espace réservé de signature se fait également à l’aide du sdk.helper. Vous devrez passer l’objet templateId et l’espace réservé id String en tant que paramètres.

sdk.helper.deleteRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=','Manager'); 


Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle