OneSpan Sign para nuevos usuarios: cómo crear y enviar su primer paquete (.NET SDK)

Michael Williams, 30 de Junio de 2015

Hasta ahora, he cubierto ejemplos simples de uso de OneSpan Sign UI y Java SDK. Ahora continuaré con un par de blogs simples que muestran el uso del SDK de OneSpan Sign .NET. Este blog cubrirá la creación y el envío de un paquete de documentos. Si no tiene una cuenta de Sandbox, consulte mi primer blog para saber cómo puedes registrarte.

Requisitos

Antes de poder escribir su código, necesitará configurar su entorno para usar .NET SDK.

Descargar el SDK de .NET

Si aún no ha descargado .NET SDK, deberá hacerlo antes de continuar con esta guía. El siguiente enlace lo llevará a una página donde puede descargar .NET SDK y también proporciona un enlace a algunos ejemplos del uso de .NET SDK en GitHub. Descomprima el SDK en la ubicación que elija.

Descargue .NET SDK

Descargando Microsoft Visual Studio

Para este blog, usaré Microsoft Visual Studio 2013. Si aún no lo tiene, puede descargar la versión de la comunidad, de forma gratuita, en el siguiente enlace. Usaré C # como lenguaje con las bibliotecas .NET. Puede usar cualquier otro entorno que le permita usar C # y .NET, pero todo en este blog describirá el uso de Visual Studio.

Descargar Microsoft Visual Studio Community 2013

Crear y enviar un paquete

Ahora que tiene las herramientas necesarias, es hora de comenzar. 

Comunidad de desarrolladores de OneSpan Sign

Comunidad de desarrolladores de OneSpan Sign

¡Únase a la comunidad de desarrolladores de OneSpan Sign! Foros, blogs, documentación, descargas de SDK y más.

Únete hoy

Crea y configura tu proyecto C #

Después de abrir Visual Studio, vaya a Archivo -> Nuevo -> Proyecto . elegí Windows -> Proyecto vacío de las plantillas y llamé a mi proyecto "CreateAndSendPackage".

 

VisualStudioCreateProject

 

Selecciona OK. Ahora verá su solución / proyecto en el Explorador de soluciones.

A continuación, agregue .NET SDK como referencia haciendo clic derecho en Referencias, en su proyecto, en el Explorador de soluciones. Elija "Agregar referencia ..." En el cuadro de diálogo que aparece, elija "Examinar", seleccione el botón "Examinar ..." en la parte inferior, navegue hasta donde descomprimió .NET SDK, seleccione los tres archivos .dll y elija Agregar.

 

Añadir referencia

 

Finalmente, haga clic derecho en su proyecto, seleccione Añadir -> Nuevo elemento ... , seleccione la sección Código en la ventana emergente, elija Archivo de código, nombre el archivo como desee (lo llamé "CreateAndSendPackge.cs") y seleccione Agregar.

 

AddCodeFile

 

Ahora verá este archivo en su proyecto en el Explorador de soluciones.

El código

Abra el archivo .cs que acaba de crear e ingrese el siguiente código.

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

espacio de nombres CreateAndSendPackage
{
    clase CreateAndSendPackage
    {
        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);

            FileStream fs = File.OpenRead ("PATH_TO_YOUR_PDF");

            DocumentPackage superDuperPackage = PackageBuilder
              .NewPackageNamed ("Paquete de prueba .NET")
                .WithSettings (DocumentPackageSettingsBuilder
                    .NewDocumentPackageSettings ())
                    .WithSigner (SignerBuilder
                         .NewSignerWithEmail ("signer.email @example .com ")
                                .WithFirstName ("Nombre del firmante")
                                .WithLastName ("Apellido del firmante")
                                .WithCustomId ("Firmante"))
                    .WithSigner (SignerBuilder
                         .NewSignerWithEmail ("your.email @example .com ")
                                .WithFirstName ("Su nombre")
                                .WithLastName ("Su apellido"))
.WithDocument (DocumentBuilder.NewDocumentNamed ("sampleAgreement")
                                  .FromStream (fs, DocumentType.PDF)
                                  .WithSignature (SignatureBuilder
                                       .SignatureFor ("signer.email  .com ")
                                         .OnPage (0)
                                         .Posición (175, 165))
                                  .WithSignature (SignatureBuilder
                                       .SignatureFor ("your.email  .com ")
                                         .OnPage (0)
                                         .Posición (550, 165))
                                  )
                    .Construir();

            PackageId packageId = eslClient.CreatePackage (superDuperPackage);
            eslClient.SendPackage (packageId);
        }

    }
}

 

Mirando el código un poco más de cerca, las primeras líneas definen las bibliotecas que usará.

 

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

 

Las siguientes líneas definen su configuración de conexión para OneSpan Sign. Asegúrese de reemplazar YOUR_API_KEY con su clave API. Puede encontrar este valor iniciando sesión en OneSpan Sign y yendo a la pestaña CUENTA.

 

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

 

Para este ejemplo muy simple, el resto del código ocurrirá dentro del método principal. Lo primero que debe hacer es conectarse al cliente OneSpan Sign utilizando la URL de API y la clave de API que definió anteriormente.

EslClient eslClient = nuevo EslClient (apiKey, apiUrl);

 

En la siguiente línea, crea un FileStream y lee el archivo que desea cargar con su paquete. Asegúrese de reemplazar el texto del marcador de posición con la ubicación de su archivo PDF.

 

FileStream fs = File.OpenRead ("PATH_TO_YOUR_PDF");

 

A continuación, se crea el paquete.

 

DocumentPackage superDuperPackage = PackageBuilder
     .NewPackageNamed ("Paquete de prueba .NET")
     .WithSettings (DocumentPackageSettingsBuilder.NewDocumentPackageSettings ())

Luego, los firmantes se agregan al paquete.

.WithSigner (SignerBuilder.NewSignerWithEmail ("signer.email @example .com ")
                      .WithFirstName ("Nombre del firmante")
                      .WithLastName ("Apellido del firmante")
                      .WithCustomId ("Firmante"))
          .WithSigner (SignerBuilder.NewSignerWithEmail ("your.email @example .com ")
                      .WithFirstName ("Su nombre")
                      .WithLastName ("Su apellido"))

Luego, se agrega el documento, incluidos los cuadros de firma para los firmantes requeridos.

.WithDocument (DocumentBuilder.NewDocumentNamed ("sampleAgreement")
                        .FromStream (fs, DocumentType.PDF)
                        .WithSignature (SignatureBuilder
                        .SignatureFor ("signer.email @example .com ")
                           .OnPage (0)
                           .Posición (175, 165))
                       .WithSignature (SignatureBuilder
                       .SignatureFor ("your.email @example .com ")
                           .OnPage (0)
                           .Posición (550, 165))
                       )

 

Con el paquete completamente definido, ahora compila el paquete y lo envía.

 

.Construir();

PackageId packageId = eslClient.CreatePackage (superDuperPackage);
eslClient.SendPackage (packageId);

 

Ahí tienes. Simplemente ejecute este código seleccionando Inicio en la barra de herramientas. Después de hacer esto, debería poder iniciar sesión en OneSpan Sign y ver el paquete que acaba de crear.

 

InboxShowingPackageCreatedWithCSharp

 

¡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. Si quieres ver más publicaciones mías, mira mi página del autor .

- Michael Williams
Gorjeo El | Facebook El | LinkedIn

 

Serie de blogs de eSignLive para nuevos usuarios