Administrar transacciones

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.getPackage(packageId); 

 Page<DocumentPackage> resultPage = eslClient.getPackageService().getPackages( new PackageStatusConverter(PackageStatus.SENT).toAPIPackageStatus(), new PageRequest(1, 10)); 

 DocumentPackage packageToUpdate = PackageBuilder.newPackageNamed(NEW_PACKAGE_NAME)   .describedAs(NEW_DESCRIPTION)   .withEmailMessage(NEW_EMAIL_MESSAGE)   .expiresAt(LocalDateTime.now().toDate())   .withLanguage(Locale.FRENCH)   .withVisibility(NEW_VISIBILITY)   .withNotarized(NEW_NOTARIZED)   .autocomplete(false)   .withSettings(settingsToUpdate)   .build();   eslClient.updatePackage(packageId, packageToUpdate); 

 eslClient.getPackageService().deletePackage(packageId); 

 eslClient.getPackageService().trash(packageId); 

 eslClient.getPackageService().archive(new PackageId("packageId")); 

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

Este tema describe cómo recuperar, actualizar, archivar y eliminar una transacción.

Recuperar transacciónes

Para recuperar una transacción, primero deberá crear un objeto PackageId utilizando el ID que se le devolvió durante la creación de la transacción. Luego, recupere la transacción usando este PackageId en el cliente OneSpan Sign. Use el siguiente código para hacerlo:

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.GetPackage(packageId); 

También puede recuperar una lista de transacciones. Use el siguiente código para hacerlo:

 Page<DocumentPackage> packages = eslClient.PackageService.GetPackages (DocumentPackageStatus.SENT, new PageRequest(1, 10)); 

El ejemplo de código anterior devolverá las primeras diez transacciones que están en estado ENVIADO. Sin embargo, puede consultar otros estados, como BORRADOR, COMPLETADO, RECHAZADO, CADUCÓ y ARCHIVADO.

Actualizar una transacción

Para actualizar una transacción existente, cree un objeto de transacción que contenga solo las actualizaciones que desea realizar en la transacción. Luego, llame a la UpdatePackage función con la PackageId de la transacción existente. Use el siguiente código para hacerlo:

 DocumentPackage packageToUpdate = PackageBuilder.NewPackageNamed(NEW_PACKAGE_NAME)   .WithEmailMessage(NEW_EMAIL_MESSAGE)   .ExpiresOn(NEW_EXPIRY_DATE)   .WithLanguage(NEW_LANGUAGE)   .WithVisibility(NEW_VISIBILITY)   .WithNotarized(NEW_NOTARIZED)   .WithoutAutomaticCompletion()   .WithSettings(settingsToUpdate)   .Build();   eslClient.UpdatePackage(packageId, packageToUpdate); 

Eliminar transacciones

Si desea eliminar permanentemente una transacción de su cuenta, llame a la función deletePackage utilizando la PackageId de la transacción que desea eliminar.

No se puede deshacer la eliminación de una transacción.

Use el siguiente código para hacerlo:

 eslClient.PackageService.DeletePackage(packageId); 

Si no desea eliminar permanentemente esta transacción, puede moverla a la carpeta Papelera de reciclaje. De esta manera no se eliminará y se puede recuperar en una fecha posterior. Use el siguiente código para hacerlo:

 eslClient.PackageService.Trash(packageId); 

Archivar transacciónes

La acción Archivo mueve las transacciones seleccionadas de su Buzón de entrada a la carpeta Archivado que contiene todas las transacciones archivadas. Esta acción solo está disponible para las transacciones completadas (COMPLETADO) en su Buzón de entrada.

Para ello, llame al cliente OneSpan Sign con el PackageId de la transacción que desea archivar. Use el siguiente código para hacerlo:

 eslClient.PackageService.Archive(new PackageId("packageId")); 

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

Este tema describe cómo recuperar, actualizar, archivar y eliminar una transacción.

Recuperar transacciónes

Para recuperar un paquete (GET), actualizar (PUT) o eliminar un paquete (DELETE), deberá realizar su solicitud a la siguiente URL utilizando la PackageId devuelta a usted durante la creación de la transacción. Use el siguiente código para hacerlo:

 {instance_url}/api/packages/{packageId} 

También puede recuperar una lista de transacciones. Use el siguiente código para hacerlo:

Solicitud HTTP

GET /api/packages?from=1&to=5&query=SENT

Encabezados HTTP

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

Carga útil de respuesta

 {   "results": [   {...},   {...},   {...},   {...},   {...}   ],   "count": 30   } 

Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.

El ejemplo de código anterior devolverá las primeras cinco transacciones que están en un estado ENVIADO, de un recuento total de 30. Sin embargo, puede consultar otros estados, como BORRADOR, COMPLETADO, RECHAZADO, CADUCÓ y ARCHIVADO.

Actualizar una transacción

Para actualizar un paquete existente que está en estado BORRADOR, simplemente cree una carga útil que contenga solo las actualizaciones que desea realizar en el paquete y realice su solicitud PUT:

Solicitud HTTP

PUT /api/packages/{packageId}

Encabezados HTTP

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

Carga útil de solicitud

{
	"due": "2017-02-13T21:18:40Z",
	"emailMessage": "new email message",
	"notarized": true,
	"settings": { ...
	},
	"description": "",
	"autocomplete": false,
	"visibility": "ACCOUNT",
	"status": "DRAFT",
	"type": "PACKAGE",
	"roles": [{
		"reassign": false,
		"locked": false,
		"index": 0,
		"type": "SENDER",
		"signers": [{
			"title": null,
			"address": null,
			"phone": "",
			"firstName": "Haris",
			"lastName": "Haidary",
			"email": "[email protected]",
			"company": "Onespan",
			"language": "fr",
			"name": ""
		}],
		"name": "Owner"
	}],
	"language": "fr",
	"name": "new package name",
	"bulkSendable": false
}

Eliminar transacciones

No se puede deshacer la eliminación de una transacción.

Si desea eliminar permanentemente una transacción de su cuenta, simplemente realice una solicitud de ELIMINACIÓN utilizando la PackageId de la transacción que desea eliminar.

Si no desea eliminar permanentemente esta transacción, puede moverla a la carpeta Papelera de reciclaje. De esta manera no se eliminará y se puede recuperar en una fecha posterior. Para ello, realice una solicitud PUT con la siguiente carga útil:

Solicitud HTTP

PUT /api/packages/{packageId}

Encabezados HTTP

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

Carga útil de solicitud

 {   "trashed": true   } 

Archivar transacciónes

La acción Archivo mueve las transacciones seleccionadas de su Buzón de entrada a la carpeta Archivado que contiene todas las transacciones archivadas. Esta acción solo está disponible para las transacciones completadas (COMPLETADO) en su Buzón de entrada.

Para archivar un paquete, simplemente actualice el estado del paquete a ARCHIVADO:

Solicitud HTTP

PUT /api/packages/{packageId}

Encabezados HTTP

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

Carga útil de solicitud

 {   "status": "ARCHIVED"   } 

Tabla de carga útil de solicitud

Propiedad	Tipo	Editable	Obligatorio	Predeterminado	Valores de ejemplo
status	string	Sí	No	BORRADOR	BORRADOR / ENVIADO / COMPLETADO / ARCHIVADO / RECHAZADO / CADUCÓ
due	string	Sí	Sí	null	2017-02-13T21:18:40Z
emailMessage	string	Sí	Sí	null	nuevo mensaje de correo electrónico
notarized	boolean	Sí	Sí	false	true / false
description	string	Sí	Sí	null	Ejemplo de transacción de STU BANK
autoComplete	boolean	Sí	No	true	true / false
type	string	Sí	No	PAQUETE	PAQUETE / FORMULARIO / FORMATO
name	string	Sí	Sí	n/a	Ejemplo de atributos de documentos
trashed	boolean	Sí	No	false	true / false
language	string	Sí	Sí	en	en / fr / es ...
visibility	string	Sí	No	CUENTA	CUENTA / REMITENTE
bulkSendable	boolean	Sí	No	false	false / true
roles
id	string	Sí	No	n/a	Client1
index	integer	Sí	No	0	0 / 1 / 2 ...
reassign	boolean	Sí	No	false	false / true
locked	boolean	Sí	No	false	false / true
name	string	Sí	No	n/a	Client1
type	string	Sí	No	FIRMANTE	FIRMANTE / REMITENTE
signers
email	string	Sí	Sí	n/a	[email protected]
firstName	string	Sí	Sí	n/a	Ernesto
lastName	string	Sí	Sí	n/a	Puente
phone	string	Sí	No	n/a	514-555-8888
id	string	Sí	No	n/a	Client1
company	string	Sí	No	n/a	Acme Inc.
address	string	Sí	No	n/a	Calle Real 123
title	string	Sí	No	n/a	Directora General
settings
ceremony
inPerson	boolean	Sí	No	false	false / true
declineButton	boolean	Sí	No	true	false / true
declineReasons	string	Sí	No	n/a	Nueva razón de rechazo n.º 1
optOutReasons	string	Sí	No	n/a	Nuevo motivo de autoexclusión n.º 1 Nota: La opción de exclusión ya no estará disponible en la Signer Experience.
disableDeclineOther	boolean	Sí	No	false	false / true
disableDownloadForUncompletedPackage	boolean	Sí	No	false	false / true
disableFirstInPersonAffidavit	boolean	Sí	No	false	false / true
disableInPersonAffidavit	boolean	Sí	No	false	false / true
disableOptOutOther	boolean	Sí	No	false	false / true Nota: La opción de exclusión ya no estará disponible en la Signer Experience.
disableSecondInPersonAffidavit	boolean	Sí	No	false	false / true
hideCaptureText	boolean	Sí	No	false	false / true
hideLanguageDropdown	boolean	Sí	No	false	false / true
hidePackageOwnerInPerson	boolean	Sí	No	false	false / true
hideWatermark	boolean	Sí	No	false	false / true
maxAuthFailsAllowed	integer	Sí	No	3	1 / 2 / 3 ...
optOutButton	boolean	Sí	No	false	false / true Nota: La opción de exclusión ya no estará disponible en la Signer Experience.
formato
iframe	boolean	Sí	No	false	false / true
navigator	boolean	Sí	No	false	false / true
header
feedback	boolean	Sí	No	false	false / true
breadcrumbs	boolean	Sí	No	false	false / true
globalNavigation	boolean	Sí	No	false	false / true
sessionBar	boolean	Sí	No	false	false / true
titleBar
progressBar	boolean	Sí	No	false	false / true
titleBar	boolean	Sí	No	false	false / true
globalActions
confirm	boolean	Sí	No	false	false / true
download	boolean	Sí	No	false	false / true
hideEvidenceSummary	boolean	Sí	No	false	false / true
saveAsLayout	boolean	Sí	No	false	false / true
brandingBar
logo
src	string	Sí	No	null	Origen de imagen de nuevo logotipo
link	string	Sí	No	null	Vínculo a imagen de nuevo logotipo
events
complete
diálogo	boolean	Sí	No	false	true / false
redirect	string	Sí	No	null	https://www.google.ca
handOver
href	string	Sí	No	null	http://www.new.ca
title	string	Sí	No	null	Nueva información sobre herramientas de vínculos de transferencia
text	string	Sí	No	null	Nuevo texto de vínculo de transferencia

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

Este tema describe cómo recuperar, actualizar, archivar y eliminar una transacción.

Recuperar transacciónes

Para recuperar una transacción, primero deberá crear un objeto PackageId utilizando el ID que se le devolvió durante la creación de la transacción. Luego, recupere la transacción usando este PackageId en el cliente OneSpan Sign. Use el siguiente código para hacerlo:

 //retrieve a package   ESignLiveSDK sdk = new ESignLiveSDK();   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); 

También puede recuperar una lista de transacciones. Use el siguiente código para hacerlo:

 public List<ESignLiveAPIObjects.Package_x> getPackages(Map<String,String> queryParameters) 

Puede pasar un mapa de parámetros de consulta para restringir su búsqueda de la siguiente manera:

 List<ESignLiveAPIObjects.Package_x> pkgs = getPackages(new Map<String,String>{'from'=>'0','to'=>'9','status'=>'SENT'}); 

El ejemplo de código anterior devolverá las primeras diez transacciones que están en estado ENVIADO. Sin embargo, puede consultar otros estados, como BORRADOR, COMPLETADO, RECHAZADO, CADUCÓ y ARCHIVADO.

Actualizar una transacción

Para actualizar una transacción existente, cree un objeto de transacción que contenga solo las actualizaciones que desea realizar en la transacción. Entonces, llame a la función updatePackage () con la PackageId de la transacción existente y el objeto updates Package_x. Use el siguiente código para hacerlo:

 //update package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); //or   ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();   pkg.name = 'changed package name';   sdk.updatePackage(pkg, packageId); 

Eliminar transacciones

Si desea eliminar permanentemente una transacción de su cuenta, llame a la función deletePackage () utilizando la PackageId de la transacción que desea eliminar.

No se puede deshacer la eliminación de una transacción.

Use el siguiente código para hacerlo:

 //delete package   sdk.deletePackage(packageId);  

Si no desea eliminar permanentemente esta transacción, puede moverla a la carpeta Papelera de reciclaje. De esta manera no se eliminará y se puede recuperar en una fecha posterior. Use el siguiente código para hacerlo:

 //trash package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);   pkg.trashed = true;   sdk.updatePackage(pkg, packageId); 

Archivar transacciónes

La acción Archivo mueve las transacciones seleccionadas de su Buzón de entrada a la carpeta Archivado que contiene todas las transacciones archivadas. Esta acción solo está disponible para las transacciones completadas (COMPLETADO) en su Buzón de entrada.

Para ello, llame a la función setStatus() con el PackageId de la transacción que desea archivar. Use el siguiente código para hacerlo:

 //archive package   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.ARCHIVED);   //you can only archive completed packages   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED); //restore archive