Création d'une transaction à partir d'un modèle

 PackageId templateId = new PackageId("ncE7Lf7h9EMvqEm7FMayLvJTJ68="); 

 DocumentPackage newPackage = PackageBuilder.newPackageNamed(PACKAGE_NAME)   .describedAs(PACKAGE_DESCRIPTION)   .withEmailMessage(PACKAGE_EMAIL_MESSAGE)   .withSigner(SignerBuilder.newSignerWithEmail(email2)   .withFirstName(PACKAGE_SIGNER_FIRST)   .withLastName(PACKAGE_SIGNER_LAST).replacing(new Placeholder(PLACEHOLDER_ID)))   .build();   PackageId packageId = eslClient.getTemplateService().createPackageFromTemplate(templateId, newPackage); 

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

Les modèles et les mises en page répondent au même objectif d'automatisation du processus de signature électronique en réduisant le temps nécessaire à l'envoi de documents comprenant plusieurs blocs de signature et champs de données. Les modèles sont idéaux pour une utilisation au niveau de la transaction; vous pouvez prédéfinir vos signataires, vos documents, les emplacements de signature et les flux de travail de signature électronique afin de rationaliser le processus de signature électronique. Une mise en page, quant à elle, est un type de modèle qui vous permet de créer des emplacements prédéfinis pour vos blocs de signature et vos champs de données dans un document. Il agit comme un « marqueur » de l'emplacement des blocs de signature et des champs de données dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires qui peuvent être légèrement différents selon le destinataire, mais dont les blocs de signature et les champs de données restent au même endroit dans tout le document. De plus, vous pouvez utiliser plusieurs mises en page par document, et les appliquer à des pages individuelles dans votre transaction.

Cette rubrique explique comment créer une transaction en utilisant un modèle existant. Si vous n'avez pas encore créé de modèle, voir Créer un modèle.

Pour commencer, récupérez l'Template ID que vous souhaitez utiliser pour votre transaction. Votre Template ID se trouve en naviguant vers le modèle dans l'interface utilisateur et en regardant dans la barre d'adresse, ou en utilisant le client OneSpan Sign.

Une fois que vous aurez récupéré votre Template ID, vous pourrez créer un nouvel PackageID. Le code suivant permet d'effectuer ce qui suit :

 PackageId templateId = new PackageId("ncE7Lf7h9EMvqEm7FMayLvJTJ68="); 

Ensuite, créez votre objet DocumentPackage avec les paramètres que vous souhaitez mettre à jour, comme indiqué dans l'exemple de code ci-dessous. Tout paramètre qui n'est pas spécifié dans l'objet DocumentPackage utilisera les paramètres du modèle. Dans cet exemple, les espaces réservés à la signature sont remplacés par un signataire.

Enfin, utilisez le bouton OneSpan Sign TemplateService pour créer votre transaction à partir de votre modèle.

 DocumentPackage newPackage = PackageBuilder.NewPackageNamed(PackageName)   .DescribedAs(PACKAGE_DESCRIPTION)   .WithEmailMessage(PACKAGE_EMAIL_MESSAGE)   .WithSigner(SignerBuilder.NewSignerWithEmail(email2)   .WithFirstName(PACKAGE_SIGNER_FIRST)   .WithLastName(PACKAGE_SIGNER_LAST).Replacing(new Placeholder(PLACEHOLDER_ID)))   .Build();   packageId = eslClient.CreatePackageFromTemplate(templateId, newPackage); 

Résultats

Après avoir exécuté votre code, vous verrez votre transaction nouvellement créée sur la page OneSpan SignÉbauches.

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

Les modèles et les mises en page répondent au même objectif d'automatisation du processus de signature électronique en réduisant le temps nécessaire à l'envoi de documents comprenant plusieurs blocs de signature et champs de données. Les modèles sont idéaux pour une utilisation au niveau de la transaction; vous pouvez prédéfinir vos signataires, vos documents, les emplacements de signature et les flux de travail de signature électronique afin de rationaliser le processus de signature électronique. Une mise en page, quant à elle, est un type de modèle qui vous permet de créer des emplacements prédéfinis pour vos blocs de signature et vos champs de données dans un document. Il agit comme un « marqueur » de l'emplacement des blocs de signature et des champs de données dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires qui peuvent être légèrement différents selon le destinataire, mais dont les blocs de signature et les champs de données restent au même endroit dans tout le document. De plus, vous pouvez utiliser plusieurs mises en page par document, et les appliquer à des pages individuelles dans votre transaction.

Cette rubrique explique comment créer une transaction en utilisant un modèle existant. Si vous n'avez pas encore créé de modèle, voir Créer un modèle.

Pour commencer, récupérez l'Template ID que vous souhaitez utiliser pour votre transaction. Votre Template ID peut être trouvé en naviguant vers le modèle dans l'interface utilisateur et en regardant dans la barre d'adresse, ou en utilisant le code suivant :

 GET https://sandbox.esignlive.com/api/packages?type=TEMPLATE

Ensuite, vous devrez construire votre JSON avec tous les paramètres que vous souhaitez mettre à jour, comme indiqué dans l'exemple de code ci-dessous. Tout paramètre qui n'est pas spécifié dans les données utiles JSON sera extrait du modèle. Dans cet exemple, les espaces réservés à la signature sont remplacés par un signataire.

Enfin, vous devrez effectuer une requête POST vers l'URI ci-dessous. Cela créera votre transaction à partir de votre modèle :

Requête HTTP

POST /api/packages/{templateId}/clone

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key 

Données utiles de la demande

 {   "name":"Package created from template through REST API",   "description":"Package created with the OneSpan Sign REST API",   "emailMessage":"This message should be delivered to all signers",   "autocomplete":true,   "type":"PACKAGE",   "visibility":"ACCOUNT",   "due":null,   "language":"en",   "status" : "DRAFT",   "roles": [   {   "id": "PlaceholderId1",   "type": "SIGNER",   "signers": [   {   "id": "PlaceholderId1",   "firstName": "Patty",   "lastName": "Gallant",   "email": "[email protected]"   }   ],   "name": "PlaceholderId1"   }   ]   } 

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

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Résultats

Après avoir exécuté votre code, vous verrez votre transaction nouvellement créée sur la page OneSpan SignÉbauches.

Tableau des données utiles de la demande

Propriété	Type	Modifiable	Requis	Par défaut	Exemples de valeurs
statut	chaîne de caractères	Oui	Non	ÉBAUCHE	ÉBAUCHE / ENVOYÉ / COMPLÉTÉ / ARCHIVÉ / DÉCLINÉ / REFUSÉ / EXPIRÉ
nom	chaîne de caractères	Oui	Non	s.o.	Paquet créé à partir d'un modèle via l'API REST
description	chaîne de caractères	Oui	Non	s.o.	Paquet créé avec l'API REST eSignLive
MessageCourriel	chaîne de caractères	Oui	Non	s.o.	Ce message doit être remis à tous les signataires
ComplétionAuto	booléen	Oui	Non	vrai	vrai / faux
type	chaîne de caractères	Oui	Non	PACKAGE	PAQUET / MODÈLE / MISE EN PAGE
visibilité	chaîne de caractères	Oui	Non	COMPTE	COMPTE / EXPÉDITEUR
dû	chaîne de caractères	Oui	Non	nul	2017-08-26
langue	chaîne de caractères	Oui	Non	en	en / fr / es ...
rôles
id	chaîne de caractères	Oui	Non	s.o.	IdEspaceRéservé1
nom	chaîne de caractères	Oui	Non	s.o.	IdEspaceRéservé1
type	chaîne de caractères	Oui	Non	SIGNER	SIGNATAIRE / EXPÉDITEUR
signataires
courriel	chaîne de caractères	Oui	Oui	s.o.	[email protected]
Prénom	chaîne de caractères	Oui	Oui	s.o.	Patty
Nom de famille	chaîne de caractères	Oui	Oui	s.o.	Galant
téléphone	chaîne de caractères	Oui	Non	s.o.	514-555-8888
id	chaîne de caractères	Oui	Non	s.o.	IdEspaceRéservé1
entreprise	chaîne de caractères	Oui	Non	s.o.	Acme Inc.
titre	chaîne de caractères	Oui	Non	s.o.	Directeur général

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

Les modèles et les mises en page répondent au même objectif d'automatisation du processus de signature électronique en réduisant le temps nécessaire à l'envoi de documents comprenant plusieurs blocs de signature et champs de données. Les modèles sont idéaux pour une utilisation au niveau de la transaction; vous pouvez prédéfinir vos signataires, vos documents, les emplacements de signature et les flux de travail de signature électronique afin de rationaliser le processus de signature électronique. Une mise en page, quant à elle, est un type de modèle qui vous permet de créer des emplacements prédéfinis pour vos blocs de signature et vos champs de données dans un document. Il agit comme un « marqueur » de l'emplacement des blocs de signature et des champs de données dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires qui peuvent être légèrement différents selon le destinataire, mais dont les blocs de signature et les champs de données restent au même endroit dans tout le document. De plus, vous pouvez utiliser plusieurs mises en page par document, et les appliquer à des pages individuelles dans votre transaction.

Cette rubrique explique comment créer une transaction en utilisant un modèle existant. Si vous n'avez pas encore créé de modèle, voir Créer un modèle.

Pour commencer, récupérez l'Template ID que vous souhaitez utiliser pour votre transaction. Votre Template ID se trouve en naviguant vers le modèle dans l'interface utilisateur et en regardant dans la barre d'adresse, ou en utilisant le client OneSpan Sign.

Une fois que vous aurez récupéré votre Template ID, vous pourrez créer un nouvel PackageID. Créez votre DocumentPackage avec les paramètres que vous souhaitez mettre à jour, comme le montre l'exemple de code ci-dessous. Tout paramètre qui n'est pas spécifié dans l'objet DocumentPackage utilisera les paramètres du modèle. Dans cet exemple, les espaces réservés à la signature sont remplacés par un signataire.

  ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();   //Set basic package info   pkg.name = 'Create Package From Template - ' + Datetime.now().format();   pkg.description = 'This is a package created from template.';   pkg.emailMessage = 'This is an email message.';   //Build actual Role in replacement of placeholder   String placeholder1Id = 'placeholder1';   ESignLiveAPIObjects.Role role1 = new ESignLiveAPIObjects.Role();   ESignLiveAPIObjects.Signer signer1 = new ESignLiveAPIObjects.Signer();   signer1.firstName = 'signer1_firstname';   signer1.lastName = 'signer1_lastname';   signer1.email = '[email protected]';   signer1.id = placeholder1Id;   role1.signers = new List<ESignLiveAPIObjects.Signer>{signer1};   role1.id = placeholder1Id;   //use role id to match placeholder   pkg.roles = new List<ESignLiveAPIObjects.Role>{role1};   pkg = sdk.helper.createPackageFromTemplate(pkg, 'E-_tmDsICwCkM2vqFuzVxF7NVQQ=');   System.debug('Package id: ' + pkg.id); 

Résultats

Après avoir exécuté votre code, vous verrez votre transaction nouvellement créée sur la page OneSpan SignÉbauches.