Téléchargement et suppression de documents

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

Cette rubrique comprend les éléments suivants :

• Comment téléverser un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées d'un document?

• Comment supprimer un document après avoir créé un paquet?

Téléversement de documents

Pour ajouter un document à un paquet existant, vous devez d'abord créer l'objet Document . Le code suivant va créer un objet Document  :

Document document = DocumentBuilder.NewDocumentNamed("Example Document")
				.FromFile("DOC_FILE_PATH")
				//.fromStream( documentStream, DocumentType.PDF );
				.WithId("document1")
				.WithDescription("Sample Document Description")
			.Build();

Une fois l'objet Document créé, trouvez l'objet PackageId auquel vous souhaitez ajouter le document, puis utilisez le client OneSpan Sign pour téléverser ce document. Le code suivant permet d'effectuer ce qui suit :

eslClient.UploadDocument(document, packageId);

Vous pouvez également téléverser plusieurs documents en un seul appel. Pour ce faire, construisez plusieurs objets Document localement et transmettez-les en tant qu'arguments variables ou en tant que liste dans le code suivant :

				eslClient.UploadDocuments(packageId, doc1, doc2, doc3);
				eslClient.UploadDocuments(packageId, new List<Document>(){doc1,doc2,doc3});
			

Remplacer un document existant

Le remplacement d'un document existant dans une transaction peut également être effectué à l'aide de la fonction de téléversement. Ceci est utile, par exemple, si vous souhaitez remplacer le document, tout en conservant la disposition des champs et des signatures.

Pour ce faire, créez un objet Document qui porte le même ID de document que le document que vous voulez remplacer, puis utilisez le client OneSpan Sign pour le téléverser. Le code suivant permet d'effectuer ce qui suit :

Document document = DocumentBuilder.NewDocumentWithName("Document1")
				.FromFile("path_to_your_file")
				.WithId("keep_the_same_document_id")
				.Build();
				eslClient.UploadDocument(document, new PackageId("the_package_id"));
			

De même, vous pouvez remplacer plusieurs documents au cours d'un même appel.

Document document = DocumentBuilder.NewDocumentWithName("Updated Document1")
				.FromFile("path_to_your_file ")
				.WithId("1dda69f88b10f2e0e6bd846aae9fca0a961aba793bf655b0")
				.Build();
				Document document2 = DocumentBuilder.NewDocumentWithName("Updated Document2")
				.FromFile("path_to_your_file ")
				.WithId("c4a6128b646f50c650779d652e5951097663a1de16c4ce72")
				.Build();
				eslClient.UploadDocuments(new PackageId("package_id"), new List<Document>(){document,document2});
			

Mise à jour des métadonnées des documents

Pour mettre à jour les métadonnées d'un document, il suffit de créer un objet Document avec les mises à jour que vous souhaitez effectuer. Par exemple :

Document document = DocumentBuilder.NewDocumentNamed("Example Document")
				.WithName("Updated document name")
				.WithDescription("Updated document description")
			.Build();

Ensuite, saisissez le DocumentPackage dans lequel vous souhaitez modifier ce document, puis utilisez le client OneSpan Sign pour mettre à jour les métadonnées du document. Le code suivant permet d'effectuer ce qui suit :

eslClient.PackageService.UpdateDocumentMetadata(documentPackage, document);

Suppression d'un document

Pour supprimer un document, appelez la fonction deleteDocument avec la chaîne packageId et documentId  :

eslClient.PackageService.DeleteDocument(packageId, document.Id.ToString());

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et visualiser les documents que vous venez d'ajouter.

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

Cette rubrique comprend les éléments suivants :

• Comment téléverser un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées d'un document?

• Comment supprimer un document après avoir créé un paquet?

Téléversement de documents

Téléchargement d'un document unique

Pour télécharger un document après avoir créé un paquet, vous devez effectuer une demande POST multiparties.

Requête HTTP

POST /api/packages/{packageId}/documents

En-têtes HTTP

Accept: text/html
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"
				{
				"name": "Example Document",
				"description": "Example Description",
				"id": "Document1"
				}
			------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

{
				"status": "",
				"description": "Example Description",
				"id": "Document1",
				"data": {
				"ese_document_texttag_extract_needed": "false"
				},
				"approvals": [
				{
				"id": "k1r2qMRtCsI5",
				"role": "48d0c024-0609-4255-9087-941a66f80738",
				"data": null,
				"signed": null,
				"accepted": null,
				"fields": [],
				"name": ""
				}
				],
				"pages": [
				{
				"id": "",
				"top": 0,
				"height": 1030,
				"width": 796,
				"left": 0,
				"index": 0,
				"version": 0
				}
				],
				"external": null,
				"extract": false,
				"signedHash": null,
				"signerVerificationToken": null,
				"index": 1,
				"fields": [],
				"name": "Example Document",
				"size": 185808
			}

Téléchargement de plusieurs documents

Pour téléverser plusieurs documents en un seul appel, vous utiliserez la même url API mais modifierez le corps de la requête de la manière suivante :

Requête HTTP

POST /api/packages/{packageId}/documents

En-têtes HTTP

Accept: text/html
Content-Type: multipart/form-data
Authorization: Basic api_key

Données utiles de la demande

------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="file"; filename="doc1.pdf"
				Content-Type: application/pdf
				%PDF-1.5
				%µµµµ
				1 0 obj
				<>>>
				endobj.... 
				------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="file"; filename="doc2.pdf"
				Content-Type: application/pdf
				%PDF-1.5
				%µµµµ
				1 0 obj
				<>>>
				endobj.... 
				------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="payload"
				[
				{
				"name": "Document1",
				"description": "Example Description",
				"id": "Document1"
				},
				{
				"name": "Document2",
				"description": "Example Description",
				"id": "Document2"
				}
				]
			------WebKitFormBoundary1bNO60n7FqP5WO4t--

Remplacer un document existant

Le remplacement d'un document existant dans une transaction peut également être effectué à l'aide de l'API de téléversement de documents. Ceci est utile, par exemple, si vous souhaitez remplacer le document, tout en conservant la disposition des champs et des signatures.

Pour ce faire, effectuez une demande POST multiparties où les données utiles JSON du document portent le même identifiant que le document original :

Requête HTTP

POST /api/packages/{packageId}/documents

En-têtes HTTP

Accept: text/html 
Content-Type: multipart/form-data 
Authorization: Basic api_key


			

Données utiles de la demande

------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="file"; filename="doc1.pdf"
				Content-Type: application/pdf
				%PDF-1.5
				%µµµµ
				1 0 obj
				<>>>
				endobj.... 
				------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="payload"
				{
				"name": "Replaced Document",
				"id": "keep_the_document_id_same"
				}
				------WebKitFormBoundary1bNO60n7FqP5WO4t--
			

De même, vous pouvez remplacer plusieurs documents, en utilisant la requête suivante :

Données utiles de la demande

------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="file"; filename="doc1.pdf"
				Content-Type: application/pdf

				%PDF-1.5
				%µµµµ
				1 0 obj
				<>>>
				endobj.... 
				------WebKitFormBoundary1bNO60n7FqP5WO4t
				Content-Disposition: form-data; name="file"; filename="doc2.pdf"
				Content-Type: application/pdf

				%PDF-1.5
				%µµµµ
				1 0 obj
				<>>>
				endobj.... 
				------WebKitFormBoundary1bNO60n7FqP5WO4t

				Content-Disposition: form-data; name="payload"
				[
				{
				"name": "Replaced Document1",
				"id": "keep_the_document1_id_same"
				},
				{
				"name": "Replaced Document2",
				"id": "keep_the_document2_id_same"
				}
				]------WebKitFormBoundary1bNO60n7FqP5WO4t--
			

Mise à jour des métadonnées des documents

Pour mettre à jour les métadonnées d'un document, vous devrez créer votre JSON en utilisant les métadonnées du document mis à jour :

{
				"name": "Example Document",
				"description": "Example Description"
			}

Ensuite, utilisez la commande suivante :

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

L'appel ci-dessus ne mettra à jour que les attributs de niveau document que vous avez définis dans vos nouvelles données utiles JSON et non les autres attributs intégrés qui peuvent être mis à jour.

Suppression d'un document

Pour supprimer un document, faites une demande SUPPRIMER à l'URI suivant :

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

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et visualiser les documents que vous venez d'ajouter.

Tableau des données utiles de la demande

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

Cette rubrique comprend les éléments suivants :

• Comment téléverser un document

• Comment remplacer un document existant

• Comment mettre à jour les métadonnées d'un document?

• Comment supprimer un document après avoir créé un paquet?

Téléversement de documents

Pour ajouter un document à un paquet existant, vous devez d'abord créer l'objet Document . Le code suivant va créer un objet Document  :

        StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc1' LIMIT 1];
				Map<String,Blob> doc = new Map<String,Blob>();
				doc.put('Sample Document', sr.Body);
         
				ESignLiveAPIObjects.Document document = new ESignLiveAPIObjects.Document();
				document.name = 'Sample Contract';
			document.id = 'document1';

Une fois l'objet Document créé, trouvez l'objet PackageId auquel vous souhaitez ajouter le document, puis utilisez le client OneSpan Sign pour téléverser ce document. Le code suivant permet d'effectuer ce qui suit :

        String documentResponse = sdk.createDocuments(packageId, document, doc);
			document = (ESignLiveAPIObjects.Document)JSON.deserialize(documentResponse, ESignLiveAPIObjects.Document.class);

Remplacer un document existant

Le remplacement d'un document existant dans une transaction peut également être effectué à l'aide de la fonction de téléversement. Ceci est utile, par exemple, si vous souhaitez remplacer le document, tout en conservant la disposition des champs et des signatures.

Pour ce faire, créez un objet Document qui porte le même ID de document que le document que vous voulez remplacer, puis utilisez le client OneSpan Sign pour le téléverser. Le code suivant permet d'effectuer ce qui suit :

StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'testdoc1' LIMIT 1];
				Map<String,Blob> doc = new Map<String,Blob>();
				doc.put('Sample Document', sr.Body);
         
				ESignLiveAPIObjects.Document document = new ESignLiveAPIObjects.Document();
				document.name = 'Updated Document';
				document.id = ‘keep_the_document_id_same’;
				String documentResponse = sdk.createDocuments(packageId, document, doc);
			

Mise à jour des métadonnées des documents

Pour mettre à jour les métadonnées d'un document, il suffit de créer un objet Document avec les mises à jour que vous souhaitez effectuer. Par exemple :

    	ESignLiveAPIObjects.Document document_updated = new ESignLiveAPIObjects.Document();
				document_updated.name = 'updated document name';
			document_updated.description = 'updated document description';

Ensuite, utilisez la fonction ci-dessous pour mettre à jour les métadonnées du document en passant l'élément package ID, document ID et l'objet mis à jour Document .

    	sdk.updateDocument(packageId, document.id, document_updated);

Suppression d'un document

Pour supprimer un document, appelez la fonction deleteDocument avec la chaîne packageId et documentId  :

    	sdk.deleteDocument(packageId, document.id);

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre transaction, vous pourrez vous connecter à votre compte OneSpan Sign et visualiser les documents que vous venez d'ajouter.