OneSpan Blog

OneSpan Sign para nuevos usuarios: Verifique el estado del paquete y descargue archivos (.NET SDK)

Programadores
Michael Williams, 7 de Julio de 2015
Thumbnail

La última vez, le mostré cómo configurar un proyecto C # dentro de Microsoft Visual Studio, para permitirle crear y enviar un paquete utilizando el SDK de OneSpan Sign .NET. Esta semana, cubriré algunas cosas que puede hacer después de enviar el paquete, como:

  • Comprobación del estado del paquete / firma
  • Descargar los documentos firmados electrónicamente
  • Descargar el resumen de evidencia

Voy a retomar justo donde lo dejé, en el blog de la semana pasada. Si lo seguiste, acabas de buscar en tu bandeja de entrada de OneSpan Sign para ver que tu paquete de documentos fue creado y enviado correctamente después de ejecutar la clase C # integrada en el tutorial.

 

InboxShowingPackageCreatedWithCSharp

 

Configuración

Configuración inicial

Cree un nuevo proyecto y un archivo .cs para este tutorial. Llamé a mi archivo, "CheckStatusAndDownload.cs". Si necesita ayuda con esta configuración, visite mi blog anterior para más instrucciones

Firmas electrónicas - Guía del principiante

Firmas electrónicas - Guía del principiante

Esta comunicación esencial de 25 páginas presenta conceptos legales importantes y consideraciones clave a la hora de crear procesos comerciales digitales con firmas electrónicas.

Descargar ahora

Localizando la ID del paquete de su proyecto existente

Dado que el paquete con el que está trabajando se creó anteriormente, necesitamos encontrar la ID del paquete para usar en este proyecto. Si selecciona el proyecto de la bandeja de entrada de la interfaz de usuario, como se ve arriba, la URL tendrá el ID del paquete, como este:

https://sandbox.esignlive.com/packages/yourPackageID

En la clase C # que creó en el último blog, verá que tenía acceso a este ID de paquete cuando creó el paquete y lo usó para enviarlo. Si estuviera creando una aplicación más compleja, es probable que almacene este ID de paquete para usarlo en otras partes de su aplicación, en lugar de buscarlo en las URL de inicio de sesión de OneSpan.

Si desea ver este ID de paquete procedente de la clase C # realizada en el tutorial del último blog, puede agregar la línea, Debug.WriteLine ("PackageId:" + packageId); después de la línea PackageId packageId = eslClient.createPackage (superDuperPackage); . Si ejecuta esa clase nuevamente, ahora verá el ID del paquete impreso en la ventana de salida en Visual Studio. 

 

visualStudioOutput_packageId

 

El código

Ahora está listo para escribir el código en su clase de C #. Copie el siguiente código en su archivo "CheckStatusAndDownload.cs" (o como lo haya llamado) que creó anteriormente.

utilizando el sistema;
utilizando System.Diagnostics;
usando Silanis.ESL.SDK;
usando Silanis.ESL.SDK.Builder;
usando System.IO;

espacio de nombres CheckStatusAndDownloadDocuments
{
    clase CheckStatusAndDownloadDocuments
    {
        Private static String apiUrl = "https://sandbox.esignlive.com/api";
        // USE https://apps.e-signlive.com/api PARA LA PRODUCCIÓN
        Cadena estática privada apiKey = "YOUR_API_KEY";

        public static void Main (cadena [] args)
        {
            EslClient eslClient = nuevo EslClient (apiKey, apiUrl);

            PackageId packageId = nuevo PackageId ("YOUR_PACKAGE_ID");
            DocumentPackage sentPackage = eslClient.GetPackage (packageId);

            DocumentPackageStatus packageStatus = sentPackage.Status;
            Debug.WriteLine ("Estado del paquete:" + packageStatus);

            SigningStatus SignatureStatus = eslClient
                            .GetSigningStatus (packageId, null, null);
            Debug.WriteLine ("Estado de firma:" + firmado del estado);

            if (signatureStatus.ToString () == "SIGNING_PENDING")
            {
                Debug.WriteLine ("No se puede descargar: Firma no completa");
            }
            más
            {
                byte [] zipContent = eslClient.DownloadZippedDocuments (packageId);
                File.WriteAllBytes (Directory.GetCurrentDirectory () 
                                    + "/package-documents.zip", zipContent);
                Debug.WriteLine ("Archivo Zip de documento descargado");

                byte [] evidenciaContenido = eslClient
                                    .DownloadEvidenceSummary (packageId);
                File.WriteAllBytes (Directory.GetCurrentDirectory () 
                                    + "/evidence-summary.pdf", evidenciaContenido);
                Debug.WriteLine ("Resumen de evidencia descargado");
            } 
        }
    }
}

Ahora, echemos un vistazo más de cerca al código. Al igual que la última vez, las primeras líneas definen su información de conexión para OneSpan Sign.

Acceda al paquete

Private static String apiUrl = "https://sandbox.esignlive.com/api";
// USE https://apps.e-signlive.com/api PARA LA PRODUCCIÓN
Cadena estática privada apiKey = "YOUR_API_KEY";

 

Asegúrese de colocar su API_KEY en lugar del marcador de posición.

Nuevamente, debido a que este es un ejemplo muy simple, el resto se realiza dentro del método principal. La primera línea dentro del método principal es donde se conecta a OneSpan Sign usando su información de conexión, desde arriba.

EslClient eslClient = nuevo EslClient (apiKey, apiUrl);

 

A continuación, se crea un objeto PackageId utilizando la ID de paquete que obtuvo de su URL (o la clase de creación de paquete C #), arriba. Luego, usará ese objeto PackageId para obtener su paquete enviado previamente desde el cliente OneSpan Sign.

PackageId packageId = nuevo PackageId ("YOUR_PACKAGE_ID");
DocumentPackage sentPackage = eslClient.GetPackage (packageId);

 

Verifica el estado

Ahora que tiene acceso al paquete de documentos, puede verificar su paquete para ver cuál es el estado del paquete. Los valores posibles son ARCHIVADO, COMPLETADO, DECLINADO, BORRADO, CADUCADO, OPTED_OUT y SENT. Continúe e imprima el estado para que podamos verlo en la consola cuando ejecutamos nuestra clase.

 

DocumentPackageStatus packageStatus = sentPackage.Status;
Debug.WriteLine ("Estado del paquete:" + packageStatus);

 

Luego, verifique el estado de firma del paquete. Los valores posibles para este son ARCHIVADO, CANCELADO, COMPLETO, RECHAZADO, CADUCADO, INACTIVO, OPTED_OUT, COMPLETED y SIGNING_PENDING. Escriba esto también en la ventana de salida de depuración.

SigningStatus SignatureStatus = eslClient.GetSigningStatus (packageId, null, null);
Debug.WriteLine ("Estado de firma:" + firmado del estado);

 

Descargar los archivos

Para la última parte, verificará si el paquete está completo. Si es así, se descargará el archivo zip de todos los documentos, así como el resumen de la evidencia. Después de cada paso, escriba en la salida de Depuración para que sepa que el evento ocurrió cuando prueba la clase en el siguiente paso.

if (signatureStatus.ToString () == "SIGNING_PENDING")
{
   Debug.WriteLine ("No se puede descargar: Firma no completa");
}
más
{
   byte [] zipContent = eslClient.DownloadZippedDocuments (packageId);
   File.WriteAllBytes (Directory.GetCurrentDirectory () 
                       + "/package-documents.zip", zipContent);
   Debug.WriteLine ("Archivo Zip de documento descargado");

   byte [] evidenciaContenido = eslClient.DownloadEvidenceSummary (packageId);
   File.WriteAllBytes (Directory.GetCurrentDirectory () 
                       + "/evidence-summary.pdf", evidenciaContenido);
   Debug.WriteLine ("Resumen de evidencia descargado");
}

 

Ejecutando el Código

Con su clase simple completada, es hora de ejecutar la clase C #. Ejecute la clase desde la barra de herramientas haciendo clic en el botón Inicio.

Si aún no ha firmado su paquete, su salida debería tener el siguiente aspecto:

 

visualStudioOutput_signingNotComplete

 

Después de firmar su paquete, obtendrá lo siguiente en su ventana de Salida:

 

visualStudioOutput_downloadComplete

 

Si ahora busca la ubicación donde guardó sus archivos (si utilizó el código anterior y está en modo de depuración, estarán en la carpeta de depuración dentro de su proyecto, en su sistema de archivos), verá que sus archivos estaban descargado con éxito

 

packageFilesDownload con .NET SDK

 

Ahí tienes. Ha verificado con éxito el estado y descargado los archivos de su paquete.

¡Gracias por leer! Si tiene preguntas o características que le gustaría ver cubiertas desde la perspectiva de un nuevo usuario, no dude en publicar en la sección de comentarios. Los enlaces a todas las publicaciones de esta serie de blogs se pueden encontrar a continuación.

- Michael Williams
Gorjeo El | Facebook El | LinkedIn

 

Serie de blogs de eSignLive para nuevos usuarios

.REDq C# código desarrollador descargar e-Sign firma electrónica paquete SDK firmando estado
Michael Williams
Volver arriba