Création d’un flux de travail de document
  • 18 Nov 2024
  • 7 Minutes à lire
  • Sombre
    Lumière
  • PDF

Création d’un flux de travail de document

  • 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 flux de travail de document détermine l’ordre dans lequel plusieurs documents doivent être signés par un signataire. Le flux de travail par défaut permet à un signataire de parcourir librement tous les documents et de les signer dans n’importe quel ordre. Cette rubrique explique comment changer cela.

Dans cet exemple, il y a deux documents à signer, le premier document devant être signé avant le deuxième document.

.withDocument(newDocumentWithName("Second Document")
                        .fromFile("src/main/resources/document.pdf")
                        .atIndex(2)
                        .withSignature(signatureFor("john@email.com")
                                .onPage(0)
                                .atPosition(100, 100)))
.withDocument(newDocumentWithName("First Document")
                        .fromFile("src/main/resources/document.pdf")
                        .atIndex(1)
                        .withSignature(signatureFor("john@email.com")
                                .onPage(0)
                                .atPosition(100, 100)))

L’exemple de code ci-dessous vous montre comment réorganiser le flux de travail du document après avoir créé le package. Si vous avez déjà envoyé votre package à signer, vous devrez changer son statut en BROUILLON avant de pouvoir mettre à jour le flux de travail du signataire.

DocumentPackage postOrderDocumentsPackage = eslClient.getPackage(packageId);
postOrderDocumentsPackage.getDocument("First Document").setIndex(2);
postOrderDocumentsPackage.getDocument("Second Document").setIndex(1);
 
eslClient.getPackageService().orderDocuments(postOrderDocumentsPackage);

Cet exemple vous montre comment modifier l’objet document. Si vous avez besoin d’une comparaison avec la procédure de base de création d’objets de document, ou si c’est la première fois que vous créez un package avec le SDK Java, consultez Creating and Sending a Transaction.

Résultats

Une fois que vous avez terminé cette procédure, vous devriez trouver le flux de travail de document approprié dans votre transaction OneSpan Sign.

Kit de développement logiciel (SDK) .NET

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

Un flux de travail de document détermine l’ordre dans lequel plusieurs documents doivent être signés par un signataire. Le flux de travail par défaut permet à un signataire de parcourir librement tous les documents et de les signer dans n’importe quel ordre. Cette rubrique explique comment changer cela.

Dans cet exemple, il y a deux documents à signer, le premier document devant être signé avant le deuxième document.

.WithDocument(DocumentBuilder.NewDocumentNamed("Second Document")
                            .FromFile("src/main/resources/document.pdf")
                            .AtIndex(2)
                            .WithSignature(SignatureBuilder.SignatureFor("john@email.com")
                                    .OnPage(0)
                                    .AtPosition(100, 100)))
.WithDocument(DocumentBuilder.NewDocumentNamed("First Document")
                            .FromFile("src/main/resources/document.pdf")
                            .AtIndex(1)
                            .WithSignature(SignatureBuilder.SignatureFor("john@email.com")
                                    .OnPage(0)
                                    .AtPosition(100, 100)))

L’exemple de code ci-dessous vous montre comment réorganiser le flux de travail du document après avoir créé le package. Si vous avez déjà envoyé votre package à signer, vous devrez changer son statut en BROUILLON avant de pouvoir mettre à jour le flux de travail du signataire.

 DocumentPackage savedPackage = eslClient.GetPackage(packageId);
savedPackage.GetDocument("First Document").Index = 2;
savedPackage.GetDocument("Second Document").Index = 1;
eslClient.PackageService.OrderDocuments(savedPackage);

Cet exemple vous montre comment modifier l’objet document.

Si vous avez besoin d’une comparaison avec la procédure de création d’objet de base, ou si c’est la première fois qu’une transaction est créée, reportez-vous à la section Creating and Sending a Transaction.

Résultats

Une fois que vous avez terminé cette procédure, vous devriez trouver le flux de travail de document approprié dans votre transaction OneSpan Sign.

REST API

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

Un flux de travail de document détermine l’ordre dans lequel plusieurs documents doivent être signés par un signataire. Le flux de travail par défaut permet à un signataire de parcourir librement tous les documents et de les signer dans n’importe quel ordre. Cette rubrique explique comment changer cela.

Dans cet exemple, il y a deux documents à signer, le premier document devant être signé avant le deuxième document.

Requête HTTP

POST /api/packages

En-têtes HTTP

Accept: application/json
Content-Type: multipart/form-data
Authorization: Basic api_key

Charge utile de la demande

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf"
Content-Type: application/pdf
%PDF-1.5
%µµµµ
1 0 obj
<>>>
endobj.... 
------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="payload"
{
  "documents": [
    {
      "id": "doc1",
      "index": 1,
      "name": "First Document"
    },
    {
      "id": "doc2",
      "index": 2,
      "name": "Second Document"
    }
  ],
  "name": "Document work flow",
  "type": "PACKAGE",
  "status": "DRAFT"
}
------WebKitFormBoundary1bNO60n7FqP5WO4t--

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

Charge utile de réponse

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

Ensuite, pour mettre à jour le flux de travail du document, vous devrez effectuer une requête PUT à l’adresse suivante :

https://sandbox.esignlive.com/api/packages/{packageId}/documents

Avec la charge utile JSON suivante :

[{
   "id":"doc1",
   "index":2
 },
 {
   "id":"doc2",
   "index":1
 }
}]

L’exemple de code ci-dessous vous montre comment réorganiser le flux de travail du document après avoir créé le package. Si vous avez déjà envoyé votre package à signer, vous devrez changer son statut en BROUILLON avant de pouvoir mettre à jour le flux de travail du signataire.

Cet exemple vous montre comment modifier l’objet document. Si vous avez besoin d’une comparaison avec la procédure de base de création d’objets document, ou si c’est la première fois que vous créez un package avec l’API REST, consultez Creating and Sending a Transaction.

Résultats

Une fois que vous avez terminé cette procédure, vous devriez trouver le flux de travail de document approprié dans votre transaction 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É

type

corde

Oui

Non

COLIS

EMBALLAGE / MODÈLE / MISE EN PAGE

nom

corde

Oui

Oui

n/a

Exemple d’attributs de document

documents

nom

corde

Oui

Non

n/a

Exemple de document

id

corde

Oui

Non

n/a

doc1

index

entier

Oui

Non

0

0 / 1 / 2 ...

APEX SDK

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

Un flux de travail de document détermine l’ordre dans lequel plusieurs documents doivent être signés par un signataire. Le flux de travail par défaut permet à un signataire de parcourir librement tous les documents et de les signer dans n’importe quel ordre. Cette rubrique explique comment changer cela.

Dans cet exemple, il y a deux documents à signer, le premier document devant être signé avant le deuxième document.

	String document1Id = 'document1'; 
        StaticResource sr1 = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc1' LIMIT 1];
        Map<String,Blob> doc1 = new Map<String,Blob>();
        doc1.put(document1Id, sr1.Body);
         
        ESignLiveAPIObjects.Document document1 = new ESignLiveAPIObjects.Document();
        document1.name = document1Id;
        document1.id = document1Id;
        document1.index = 1;
        sdk.createDocuments(packageId, document1, doc1);
    	
    	
    	String document2Id = 'document2';
    	StaticResource sr2 = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc2' LIMIT 1];
    	Map<String,Blob> doc2 = new Map<String,Blob>();
    	doc2.put(document2Id, sr2.Body);
    	
    	ESignLiveAPIObjects.Document document2 = new ESignLiveAPIObjects.Document();
        document2.name = document2Id;
        document2.id = document2Id;
        document2.index = 2;
        sdk.createDocuments(packageId, document2, doc2);

L’exemple de code ci-dessous vous montre comment réorganiser le flux de travail du document après avoir créé le package. Si vous avez déjà envoyé votre package à signer, vous devrez changer son statut en BROUILLON avant de pouvoir mettre à jour le flux de travail du signataire.

    	//update docuemnt work flow in existing package
    	pkg = sdk.getPackage(packageId);
    	
    	document1 = getDocument(pkg,'document1');
    	document1.index = 2;
    	document2 = getDocument(pkg,'document2');
    	document2.index = 1;
    	
    	updateDocuments(packageId, pkg.documents);	

Cet exemple vous montre comment modifier l’objet document. Si vous avez besoin d’une comparaison avec la procédure de création d’objet de document de base, ou si c’est la première fois que vous créez un package avec le SDK Apex, reportez-vous à la Creating and Sending a Transaction.

Résultats

Une fois que vous avez terminé cette procédure, vous devriez trouver le flux de travail de document approprié dans votre transaction OneSpan Sign.


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