Desarrollador de Signos OneSpan: Archivo, Papelera y Borrado

Duo Liang, 7 de Noviembre de 2018

En OneSpan Sign, Archive, Trash y Delete son todas acciones de transacción que le permiten gestionar el ciclo de vida de su transacción después de que se haya completado o ya no se necesite. Si desea restringir el acceso a las transacciones completadas o simplemente quiere eliminar una transacción, este blog aclarará los conceptos y el comportamiento de estas tres acciones de transacción, le ayudará a entender cómo están diseñadas y le explicará cómo aplicarlas mediante programación.

ARCHIVO

En OneSpan Sign, existen los siguientes estados de los paquetes:

BORRADOR / ENVIADO / COMPLETADO / ARCHIVADO / RECHAZADO / OPTED_OUT / EXPIRADO

Observe que sólo "ARCHIVADO" es un estado del paquete mientras que los otros dos temas "BASURA" y "BORRADO" no lo son.

La acción de Archivar mueve las transacciones seleccionadas de su Bandeja de Entrada a la carpeta Archivada que contiene todas sus transacciones archivadas. Esta acción sólo está disponible para las transacciones "COMPLETADAS" en su bandeja de entrada.11-07-1

La acción Restaurar se utiliza para cambiar las transacciones seleccionadas a su estado anterior. Esta acción sólo está disponible para las transacciones que se encuentran en la carpeta Archivada o Papelera. Por ejemplo, la acción Restaurar cambiará el estado de un paquete de "ARCHIVADO" a "COMPLETADO".

En REST:

HTTP Request PUT /api/packages/{packageId} HTTP Headers Authorization: Basic api_key Accept: application/json Content-Type: application/json Request Payload { "status": "ARCHIVED"/"COMPLETED" }

En el SDK de Java:

eslClient.getPackageService().archive(packageId); //acción de archivar eslClient.getPackageService().markComplete(packageId); //restaurar archivo

En el SDK de .Net:

eslClient.PackageService.Archive(packageId); //acción de archivar eslClient.PackageService.MarkComplete(packageId); //restaurar archivo

En el SDK de Apex

ESignLiveSDK sdk = new ESignLiveSDK(); sdk.setStatus("packageID", ESignLiveAPIObjects.PackageStatus.ARCHIVED); //acción de archivar sdk.setStatus("packageID", ESignLiveAPIObjects.PackageStatus.COMPLETED); //restaurar archivo

Una vez archivado un paquete, su firmante no tendrá acceso al mismo. Cuando hagan clic en el enlace de descarga de su correo electrónico, verán "Acceso denegado", como muestra la siguiente imagen. 11-07-2

Mientras que como remitente, todavía puede recuperar los metadatos, descargar los documentos/resumen de pruebas, llamar a las funciones REST/SDK como puede hacerlo con cualquier otro paquete "COMPLETO".

BASURA

La acción de la Papelera se utiliza para mover una transacción seleccionada de su Bandeja de Entrada/Borradores/Carpeta de Archivo a la Papelera.

Como hemos mencionado anteriormente, "TRASHED" no es un estado del paquete, así que ¿cómo podemos representar un paquete como basura? Hay un atributo separado llamado "trashed" en el paquete JSON. 11-07-3

Si esta propiedad se establece como "true", el paquete es "TRASHED", y sólo puede encontrarlo en su Carpeta de Basura. Dado que la eliminación de un paquete no cambia su estado, si se establece la propiedad de nuevo a false, el paquete se recuperará manteniendo el estado adecuado.

 

En REST:

Solicitud HTTP PUT /api/packages/{packageId} Cabeceras HTTP Authorization: Basic api_key Accept: application/json Content-Type: application/json Carga útil de la solicitud { "trashed": true/false }

En el SDK de Java:

eslClient.getPackageService().trash(packageId); //acción de basura eslClient.getPackageService().restore(packageId); //restaurar la basura

En el SDK de .Net:

eslClient.PackageService.Trash(packageId); //acción de basura eslClient.PackageService.Restore(packageId); //restaurar la basura

En Apex SDK:

ESignLiveSDK sdk = new ESignLiveSDK(); String packageId = '2APPpsAcqVk8QbJKABFqWvHy-kQ='; ESignLiveAPIObjects.Package_x pack = sdk.getPackage(packageId); pack.trashed = true; //acción de basura //pack.trashed = false; //restaurar la basura sdk.updatePackage(pack, packageId);

Al tirar un paquete a la papelera, lo pondremos en la carpeta TRASH durante 2 semanas, tras las cuales se eliminará de forma permanente.

DELETE

Una solicitud "DELETE" se realiza llamando a la misma api REST que recupera los metadatos del paquete. Una vez que se borra un paquete, sólo se conserva el packageID con un estado de BORRADO en OneSpan Sign. Todo lo demás se elimina y no se puede restablecer.

En REST:

Solicitud HTTP DELETE /api/packages/{packageId} Cabeceras HTTP Authorization: Basic api_key Accept: application/json Content-Type: application/json

En el SDK de Java:

eslClient.getPackageService().deletePackage(packageId); //acción de eliminación

En el SDK de .Net:

eslClient.PackageService.DeletePackage(packageId); //acción de eliminación

En Apex SDK:

ESignLiveSDK sdk = new ESignLiveSDK(); sdk.deletePackage('packageId'); //acción de borrado

La acción de Borrar difiere de la acción de la Papelera porque, no hay manera de restaurar un paquete después de haberlo borrado. Al intentar acceder de nuevo a la transacción, siempre verá la imagen de abajo, que le indica que el paquete ya no es accesible. Con Trash Action, todavía tiene la posibilidad de restaurar su paquete en un plazo de 2 semanas 11-07-4

A través del blog de hoy, hemos revisado tres acciones de transacción: Archivo, Papelera y Borrar. Ahora tiene una comprensión más clara de cómo están diseñadas y aprende a utilizarlas o restaurarlas tanto en métodos REST como SDK.

Si tiene alguna pregunta sobre este blog o cualquier otra cosa relacionada con la integración de OneSpan Sign en su aplicación, visite los foros de la comunidad de desarrolladores. Su opinión nos importa

Popup default