- 18 Nov 2024
- 9 Minutes à lire
- SombreLumière
- PDF
Création d’une transaction à partir d’un modèle
- Mis à jour le 18 Nov 2024
- 9 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 .
Les modèles et les mises en page remplissent le 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 des transactions : vous pouvez prédéfinir vos signataires, vos documents, vos emplacements de signature et vos flux de travail de signature électronique pour 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 au sein d’un document. Il agit comme un « marqueur » où les blocs de signature et les champs de données se trouveront 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 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 de votre transaction.
Cette rubrique explique comment créer une transaction à l’aide d’un modèle existant. Si vous n’avez pas encore créé de modèle, reportez-vous à la section Creating a Template.
Pour commencer, récupérez l’ID de modèle du modèle que vous souhaitez utiliser pour votre transaction. Vous pouvez trouver votre ID de modèle en accédant au 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 avez récupéré votre ID de modèle , vous pouvez créer un nouvel ID de package. Pour ce faire, le code suivant :
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, signature placeholders sont remplacés par un signataire.
Enfin, utilisez le OneSpan Sign TemplateService pour créer votre transaction à partir de votre modèle.
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);
Résultats
Après avoir exécuté votre code, vous verrez votre transaction nouvellement créée sur la page Brouillons de OneSpan Sign.
Kit de développement logiciel (SDK) .NET
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Les modèles et les mises en page remplissent le 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 des transactions : vous pouvez prédéfinir vos signataires, vos documents, vos emplacements de signature et vos flux de travail de signature électronique pour 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 au sein d’un document. Il agit comme un « marqueur » où les blocs de signature et les champs de données se trouveront 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 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 de votre transaction.
Cette rubrique explique comment créer une transaction à l’aide d’un modèle existant. Si vous n’avez pas encore créé de modèle, reportez-vous à la section Creating a Template.
Pour commencer, récupérez l’ID de modèle du modèle que vous souhaitez utiliser pour votre transaction. Vous pouvez trouver votre ID de modèle en accédant au 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 avez récupéré votre ID de modèle , vous pouvez créer un nouvel ID de package. Pour ce faire, le code suivant :
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, signature placeholders sont remplacés par un signataire.
Enfin, utilisez le 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 Brouillons de OneSpan Sign.
REST API
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Les modèles et les mises en page remplissent le 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 des transactions : vous pouvez prédéfinir vos signataires, vos documents, vos emplacements de signature et vos flux de travail de signature électronique pour 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 au sein d’un document. Il agit comme un « marqueur » où les blocs de signature et les champs de données se trouveront 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 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 de votre transaction.
Cette rubrique explique comment créer une transaction à l’aide d’un modèle existant. Si vous n’avez pas encore créé de modèle, reportez-vous à la section Creating a Template.
Pour commencer, récupérez l’ID de modèle du modèle que vous souhaitez utiliser pour votre transaction. Vous pouvez trouver votre ID de modèle en accédant au 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 générer votre JSON 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 la charge utile JSON sera extrait du modèle. Dans cet exemple, signature placeholders sont remplacés par un signataire.
Enfin, vous devrez effectuer une requête POST à 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
Charge utile 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": "patty.galant@example.com"
}
],
"name": "PlaceholderId1"
}
]
}
Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.
Charge utile de 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 Brouillons de OneSpan Sign.
Tableau des données utiles de la demande
Propriété | Type | Modifiable | Obligatoire | Faire défaut | Exemples de valeurs |
---|---|---|---|---|---|
statut | corde | Oui | Non | BROUILLON | BROUILLON / ENVOYÉ / TERMINÉ / ARCHIVÉ / REFUSÉ / OPTED_OUT / EXPIRÉ |
nom | corde | Oui | Non | n/a | Package créé à partir d’un modèle via l’API REST |
description | corde | Oui | Non | n/a | Package créé avec l’API REST eSignLive |
par e-mailMessage | corde | Oui | Non | n/a | Ce message doit être remis à tous les signataires |
Saisie semi-automatique | booléen | Oui | Non | vrai | vrai / faux |
type | corde | Oui | Non | COLIS | EMBALLAGE / MODÈLE / MISE EN PAGE |
visibilité | corde | Oui | Non | COMPTE | COMPTE / EXPÉDITEUR |
due | corde | Oui | Non | zéro | 2017-08-26 |
Langue | corde | Oui | Non | en | en / fr / es ... |
Rôles | |||||
id | corde | Oui | Non | n/a | Espace réservéId1 |
nom | corde | Oui | Non | n/a | Espace réservéId1 |
type | corde | Oui | Non | SIGNATAIRE | SIGNATAIRE / EXPÉDITEUR |
Signataires | |||||
Messagerie électronique | corde | Oui | Oui | n/a | patty.galant@example.com |
prénom | corde | Oui | Oui | n/a | Patty |
nomNom de famille | corde | Oui | Oui | n/a | Galant |
Téléphone | corde | Oui | Non | n/a | 514-555-8888 |
id | corde | Oui | Non | n/a | Espace réservéId1 |
compagnie | corde | Oui | Non | n/a | Acme Inc. |
titre | corde | Oui | Non | n/a | Directeur général |
APEX SDK
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Les modèles et les mises en page remplissent le 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 des transactions : vous pouvez prédéfinir vos signataires, vos documents, vos emplacements de signature et vos flux de travail de signature électronique pour 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 au sein d’un document. Il agit comme un « marqueur » où les blocs de signature et les champs de données se trouveront 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 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 de votre transaction.
Cette rubrique explique comment créer une transaction à l’aide d’un modèle existant. Si vous n’avez pas encore créé de modèle, reportez-vous à la section Creating a Template.
Pour commencer, récupérez l’ID de modèle du modèle que vous souhaitez utiliser pour votre transaction. Vous pouvez trouver votre ID de modèle en accédant au 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 avez récupéré votre ID de modèle , vous pouvez créer un nouvel ID de package. Créez votre objet DocumentPackage avec les paramètres que vous souhaitez mettre à jour, comme illustré 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, signature placeholders 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 = 'signer1@mailiantor.com';
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 Brouillons de OneSpan Sign.