Création d'un flux de travail pour les documents

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

Un flux de travail de documents 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 devant être signé avant le second.

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

L'exemple de code ci-dessous vous montre comment réorganiser le flux de travail des documents après avoir créé le paquet. Si vous avez déjà envoyé votre paquet à signer, vous devrez changer son statut en ÉBAUCHE 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 du document. Si vous avez besoin d'une comparaison avec la procédure de base de création d'un objet document, ou si c'est la première fois que vous créez un paquet avec le SDK Java, consultez Création et envoi d'une transaction.

Résultats

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

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

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

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

 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 du document.

Si vous avez besoin d'une comparaison avec la procédure de création d'objets de base, ou si c'est la première fois que vous créez une transaction, consultez la rubrique Création et envoi d'une transaction.

Résultats

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

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

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

Requête HTTP

POST /api/packages

En-têtes HTTP

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

Données utiles 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, voir la section Données utiles de la demande ci-dessous.

Données utiles de la réponse

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

Ensuite, pour mettre à jour le flux de travail des documents, vous devrez faire une demande PUT à :

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

Avec les données utiles JSON suivantes :

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

Cet exemple vous montre comment modifier l'objet du document. Si vous avez besoin d'une comparaison avec la procédure de base de création d'un objet document, ou si c'est la première fois que vous créez un paquet avec l'API REST, consultez la rubrique Création et envoi d'une transaction.

Résultats

Une fois que vous aurez 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	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É
type	chaîne de caractères	Oui	Non	PACKAGE	PAQUET / MODÈLE / MISE EN PAGE
nom	chaîne de caractères	Oui	Oui	s.o.	Exemple d'attributs de document
documents
nom	chaîne de caractères	Oui	Non	s.o.	exemple de document
id	chaîne de caractères	Oui	Non	s.o.	doc1
index	entier	Oui	Non	0	0 / 1 / 2 ...

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

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

	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);

    	//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 du document. Si vous avez besoin d'une comparaison avec la procédure de création d'un objet document de base, ou si c'est la première fois que vous créez un paquet avec le SDK Apex, consultez la section Création et envoi d'une transaction.

Résultats

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

Résultats

Résultats

Requête HTTP

En-têtes HTTP

Données utiles de la demande

Données utiles de la réponse

Résultats

Tableau des données utiles de la demande

Résultats

Log in

Two-step verification is required