Cargar y eliminar documentos

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Este tema consta de lo siguiente:

• Cómo cargar un documento

• Cómo reemplazar un documento existente

• Cómo actualizar los metadatos de un documento

• Cómo eliminar un documento después de haber creado un paquete

Cargar documentos

Para agregar un documento a un paquete existente, debe crear primero el objeto Document . El siguiente código creará un objeto Document :

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

Una vez creado el objeto Document , busque el PackageId al que desea agregar el documento y luego use el cliente de OneSpan Sign para cargar ese documento. El siguiente código hará lo siguiente:

eslClient.UploadDocument(document, packageId);

También puede cargar varios documentos en una sola llamada. Para ello, cree varios objetos Document localmente y páselos como argumentos variables o como una lista en el siguiente código:

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

Sustituir un documento existente

La sustitución de un documento existente en una transacción también se puede realizar mediante la función Cargar. Esto es útil, por ejemplo, si desea reemplazar el documento, pero manteniendo el diseño de los campos y las firmas.

Para ello, cree un objeto Document que lleve el mismo ID de documento que el documento que desea reemplazar y, a continuación, utilice el cliente de OneSpan Sign para cargarlo. El siguiente código hará lo siguiente:

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

Del mismo modo, puede reemplazar varios documentos dentro de una misma llamada.

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

Actualizar metadatos de documentos

Para actualizar los metadatos de un documento, simplemente cree un objeto Document con las actualizaciones que desee realizar. Por ejemplo:

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

Luego, tome el DocumentPackage en el que desee cambiar este documento y luego use el cliente de OneSpan Sign para actualizar los metadatos del documento. El siguiente código hará lo siguiente:

eslClient.PackageService.UpdateDocumentMetadata(documentPackage, document);

Eliminar un documento

Para eliminar un documento, llame a la función deleteDocument con el packageId y la cadena documentId :

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

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su transacción, podrá iniciar sesión en su cuenta de OneSpan Sign y ver los documentos que acaba de agregar.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Este tema consta de lo siguiente:

• Cómo cargar un documento

• Cómo reemplazar un documento existente

• Cómo actualizar los metadatos de un documento

• Cómo eliminar un documento después de haber creado un paquete

Cargar documentos

Cargar un solo documento

Para cargar un documento después de crear un paquete, deberá realizar una solicitud POST multiparte.

Solicitud HTTP

POST /api/packages/{packageId}/documents

Encabezados HTTP

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

Carga útil de solicitud

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

Para obtener una descripción completa de cada campo, consulte la sección Carga útil de solicitud más abajo.

Carga útil de respuesta

{
				"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
			}

Cargar varios documentos

Para cargar varios documentos en una misma llamada, debe usar la misma URL de API, pero modificando el cuerpo de la solicitud de la siguiente manera:

Solicitud HTTP

POST /api/packages/{packageId}/documents

Encabezados HTTP

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

Carga útil de solicitud

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

Sustituir un documento existente

La sustitución de un documento existente en una transacción también se puede realizar mediante la API de carga de documentos. Esto es útil, por ejemplo, si desea reemplazar el documento, pero manteniendo el diseño de los campos y las firmas.

Para ello, realice una solicitud POST multiparte cuando la carga útil JSON del documento lleve el mismo ID de documento que el documento original:

Solicitud HTTP

POST /api/packages/{packageId}/documents

Encabezados HTTP

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


			

Carga útil de solicitud

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

Del mismo modo, puede reemplazar varios documentos utilizando la siguiente solicitud:

Carga útil de solicitud

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

Actualizar metadatos de documentos

Para actualizar los metadatos de un documento, deberá crear su JSON utilizando los metadatos de documento actualizados:

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

A continuación, utilice el siguiente comando:

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

La llamada anterior solo actualizará los atributos de nivel de documento que definió en su nueva carga JSON y no cualquier otro atributo incrustado que se pueda actualizar.

Eliminar un documento

Para eliminar un documento, realice una solicitud ELIMINAR en el siguiente URI:

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

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su transacción, podrá iniciar sesión en su cuenta de OneSpan Sign y ver los documentos que acaba de agregar.

Tabla de carga útil de solicitud

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Este tema consta de lo siguiente:

• Cómo cargar un documento

• Cómo reemplazar un documento existente

• Cómo actualizar los metadatos de un documento

• Cómo eliminar un documento después de haber creado un paquete

Cargar documentos

Para agregar un documento a un paquete existente, debe crear primero el objeto Document . El siguiente código creará un objeto 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';

Una vez creado el objeto Document , busque el PackageId al que desea agregar el documento y luego use el cliente de OneSpan Sign para cargar ese documento. El siguiente código hará lo siguiente:

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

Sustituir un documento existente

La sustitución de un documento existente en una transacción también se puede realizar mediante la función Cargar. Esto es útil, por ejemplo, si desea reemplazar el documento, pero manteniendo el diseño de los campos y las firmas.

Para ello, cree un objeto Document que lleve el mismo ID de documento que el documento que desea reemplazar y, a continuación, utilice el cliente de OneSpan Sign para cargarlo. El siguiente código hará lo siguiente:

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

Actualizar metadatos de documentos

Para actualizar los metadatos de un documento, simplemente cree un objeto Document con las actualizaciones que desee realizar. Por ejemplo:

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

A continuación, utilice la función mostrada abajo para actualizar los metadatos del documento entregando el package ID, el document ID y Document actualizado.

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

Eliminar un documento

Para eliminar un documento, llame a la función deleteDocument con el packageId y la cadena documentId :

    	sdk.deleteDocument(packageId, document.id);

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su transacción, podrá iniciar sesión en su cuenta de OneSpan Sign y ver los documentos que acaba de agregar.