Nous avons effectué des mises à jour ! Consultez notre portail de documentation mis à jour ! En savoir plus...

Créer une transaction à partir d’un modèle

Prev Next

Java SDK

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

Les modèles et mises en page remplissent le même objectif : automatiser le processus de signature électronique en réduisant le temps nécessaire pour envoyer des documents incluant plusieurs blocs de signature et champs de données. Les modèles sont idéaux à utiliser au niveau de la transaction – vous pouvez prédéfinir vos signataires, documents, emplacements de signature et flux de travail de signature électronique pour simplifier le processus de signature électronique. Une mise en page, en revanche, 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 placent dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires légèrement différents selon le destinataire, mais les blocs de signature et les champs de données restent au même endroit tout au long du document. De plus, vous pouvez utiliser plusieurs mises en page par document et les appliquer à des pages individuelles dans votre transaction.

Ce sujet explique comment créer une transaction à partir d’un modèle existant. Si vous n’avez pas encore créé de modèle, consultez la section Création d’un modèle.

Pour commencer, récupérez l’identifiant du modèle que vous souhaitez utiliser pour votre transaction. Votre identifiant de modèle peut être trouvé en naviguant dans le modèle dans l’interface utilisateur et en consultant la barre d’adresse, ou en utilisant le client OneSpan Sign.

Une fois que vous avez récupéré votre identifiant de modèle , vous pouvez créer un nouvel ID de paquet. Le code suivant le fera ainsi :

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

Ensuite, créez votre objet DocumentPackage avec tous les paramètres que vous souhaitez mettre à jour, comme indiqué dans le code d’exemple ci-dessous. Tout paramètre non spécifié dans l’objet DocumentPackage utilisera les paramètres du modèle. Dans cet exemple, les placeholders de signature sont remplacés par un signataire.

Enfin, utilisez le OneSpan Sign Template Service 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 nouvelle transaction créée sur la page OneSpan Sign Drafts .

.NET SDK

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

Les modèles et mises en page remplissent le même objectif : automatiser le processus de signature électronique en réduisant le temps nécessaire pour envoyer des documents incluant plusieurs blocs de signature et champs de données. Les modèles sont idéaux à utiliser au niveau de la transaction – vous pouvez prédéfinir vos signataires, documents, emplacements de signature et flux de travail de signature électronique pour simplifier le processus de signature électronique. Une mise en page, en revanche, 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 placent dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires légèrement différents selon le destinataire, mais les blocs de signature et les champs de données restent au même endroit tout au long du document. De plus, vous pouvez utiliser plusieurs mises en page par document et les appliquer à des pages individuelles dans votre transaction.

Ce sujet explique comment créer une transaction à partir d’un modèle existant. Si vous n’avez pas encore créé de modèle, consultez la section Création d’un modèle.

Pour commencer, récupérez l’identifiant du modèle que vous souhaitez utiliser pour votre transaction. Votre identifiant de modèle peut être trouvé en naviguant dans le modèle dans l’interface utilisateur et en consultant la barre d’adresse, ou en utilisant le client OneSpan Sign.

Une fois que vous avez récupéré votre identifiant de modèle , vous pouvez créer un nouvel ID de paquet. Le code suivant le fera ainsi :

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

Ensuite, créez votre objet DocumentPackage avec tous les paramètres que vous souhaitez mettre à jour, comme indiqué dans le code d’exemple ci-dessous. Tout paramètre non spécifié dans l’objet DocumentPackage utilisera les paramètres du modèle. Dans cet exemple, les placeholders de signature sont remplacés par un signataire.

Enfin, utilisez le OneSpan Sign Template Service 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 nouvelle transaction créée sur la page OneSpan Sign Drafts .

REST API

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

Les modèles et mises en page remplissent le même objectif : automatiser le processus de signature électronique en réduisant le temps nécessaire pour envoyer des documents incluant plusieurs blocs de signature et champs de données. Les modèles sont idéaux à utiliser au niveau de la transaction – vous pouvez prédéfinir vos signataires, documents, emplacements de signature et flux de travail de signature électronique pour simplifier le processus de signature électronique. Une mise en page, en revanche, 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 placent dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires légèrement différents selon le destinataire, mais les blocs de signature et les champs de données restent au même endroit tout au long du document. De plus, vous pouvez utiliser plusieurs mises en page par document et les appliquer à des pages individuelles dans votre transaction.

Ce sujet explique comment créer une transaction à partir d’un modèle existant. Si vous n’avez pas encore créé de modèle, consultez la section Création d’un modèle.

Pour commencer, récupérez l’identifiant du modèle que vous souhaitez utiliser pour votre transaction. Votre identifiant de modèle peut être trouvé en naviguant dans le modèle dans l’interface utilisateur et en consultant 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 montré dans le code d’exemple ci-dessous. Tout paramètre non spécifié dans la charge utile JSON sera extrait du modèle. Dans cet exemple, les placeholders de signature sont remplacés par un signataire.

Enfin, vous devrez faire 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

Les propriétés suivantes ne sont pas clonées du modèle vers la nouvelle transaction :    

  • deliverDocumentsByEmail

  • reassign

Ces propriétés ne sont pas héritées du modèle et doivent être explicitement définies dans la charge utile de requête.

En-têtes HTTP

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

Charge utile de 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, voir le tableau des charges utiles de 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 nouvelle transaction créée sur la page OneSpan Sign Drafts .

Table des charges utiles de requêtes

Propriété

Type

Modifiable

Obligatoire

Par défaut

Valeurs d’échantillonnage

Statut

Corde

Oui

Non

DRAFT

BROUILLON / ENVOYÉ / COMPLÉTÉ / ARCHIVÉ / REFUSÉ / OPTED_OUT / EXPIRÉ

Nom

Corde

Oui

Non

N/D

Paquet créé à partir d’un modèle via l’API REST

Description

Corde

Oui

Non

N/D

Package créé avec l’API eSignLive REST

emailMessage

Corde

Oui

Non

N/D

Ce message doit être transmis à tous les signataires

autoComplete

Booléen

Oui

Non

Vrai

vrai / faux

Type

Corde

Oui

Non

PAQUET

PACKAGE / MODÈLE / MISE EN PAGE

Visibilité

Corde

Oui

Non

COMPTE

COMPTE / EXPÉDITEUR

Corde

Oui

Non

null

2017-08-26

Langue

Corde

Oui

Non

en

en / fr / es ...

Rôles

id

Corde

Oui

Non

N/D

PlaceholderId1

Nom

Corde

Oui

Non

N/D

PlaceholderId1

Type

Corde

Oui

Non

SIGNATAIRE

SIGNATAIRE / EXPÉDITEUR

Signataires

Email

Corde

Oui

Oui

N/D

patty.galant@example.com

Prénom

Corde

Oui

Oui

N/D

Patty

Nom de famille

Corde

Oui

Oui

N/D

Galant

téléphone

Corde

Oui

Non

N/D

514-555-8888

id

Corde

Oui

Non

N/D

PlaceholderId1

Entreprise

Corde

Oui

Non

N/D

Acme Inc.

Titre

Corde

Oui

Non

N/D

Directeur général

APEX SDK

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

Les modèles et mises en page remplissent le même objectif : automatiser le processus de signature électronique en réduisant le temps nécessaire pour envoyer des documents incluant plusieurs blocs de signature et champs de données. Les modèles sont idéaux à utiliser au niveau de la transaction – vous pouvez prédéfinir vos signataires, documents, emplacements de signature et flux de travail de signature électronique pour simplifier le processus de signature électronique. Une mise en page, en revanche, 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 placent dans le document. Les mises en page sont utiles pour les utilisateurs qui envoient fréquemment des formulaires légèrement différents selon le destinataire, mais les blocs de signature et les champs de données restent au même endroit tout au long du document. De plus, vous pouvez utiliser plusieurs mises en page par document et les appliquer à des pages individuelles dans votre transaction.

Ce sujet explique comment créer une transaction à partir d’un modèle existant. Si vous n’avez pas encore créé de modèle, consultez la section Création d’un modèle.

Pour commencer, récupérez l’identifiant du modèle que vous souhaitez utiliser pour votre transaction. Votre identifiant de modèle peut être trouvé en naviguant dans le modèle dans l’interface utilisateur et en consultant la barre d’adresse, ou en utilisant le client OneSpan Sign.

Une fois que vous avez récupéré votre identifiant de modèle , vous pouvez créer un nouvel ID de paquet. Créez votre objet DocumentPackage avec tous les paramètres que vous souhaitez mettre à jour, comme montré dans le code d’exemple ci-dessous. Tout paramètre non spécifié dans l’objet DocumentPackage utilisera les paramètres du modèle. Dans cet exemple, les placeholders de 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 = '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 nouvelle transaction créée sur la page OneSpan Sign Drafts .