OneSpan Blog

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

Programadores
Michael Williams, 16 de Junio de 2015
Thumbnail

Mis primeros dos blogs cubiertos creando, enviando , Firmar, archivar y ver el resumen de evidencia de un paquete de documentos de signos OneSpan, utilizando la interfaz de usuario. Con eso completo, ahora es el momento de ingresar a las API. Mi idioma principal de uso durante los últimos 7 años y desde la escuela fue Java, por lo que comenzaré con el SDK de Java.

Si no tiene una cuenta de Sandbox, consulte mi primer blog. De lo contrario, continúe, a continuación.

Requisitos

Primero, cubriremos algunos requisitos para seguir junto con este blog.

Descargar el SDK de Java

Antes de que podamos usar el SDK de Java, deberá descargarlo. En el siguiente enlace encontrará enlaces a la descarga de Java SDK, Java SDK JavaDoc y los ejemplos de GitHub Java. También verá descargas e información para .NET SDK y Mobile SDK.

Descargar el SDK de Java

 

Descargar un IDE de Java

Usaré el IDE de Eclipse en este blog. Puede usar otro, pero todo en este blog se describirá con Eclipse. A continuación hay un enlace para descargar Eclipse. Estoy usando el "Eclipse para desarrolladores de informes y Java" porque lo uso para la herramienta de informes BIRT, más adelante en este ejemplo.

Descargar Eclipse

Continúe e instale Eclipse descomprimiendo el archivo zip en su ubicación preferida. Elegí "C: / Eclipse /".

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

Crear y enviar un paquete

Ahora que tenemos todos los elementos esenciales para completar el tutorial, podemos seguir adelante y comenzar.

Crear y configurar un proyecto Java

Abra Eclipse ejecutando eclipse.exe desde la carpeta raíz "eclipse". Una vez que se ha iniciado: si aún no está abierto, abra la perspectiva Java. Puedes hacer esto yendo a Ventana -> Perspectiva abierta -> Otro ... -> Java .

javaPerspective

Una vez que tenga abierta la perspectiva Java, debería ver una Vista llamada "Explorador de paquetes" en el lado izquierdo de la pantalla. Haga clic derecho dentro de esta ventana y vaya a Nuevo -> Proyecto Java . Eso abrirá una ventana como la siguiente:

javaProject

Nombra tu proyecto como quieras. Yo solía, "CreateAndSendPackage". Luego, presiona siguiente.

Elija la pestaña Bibliotecas, haga clic en el botón "Agregar archivos JAR externos ...", navegue a la ubicación donde guardó su SDK y seleccione el jar "sdk - jar-with-dependencies". Después de seleccionar "Abrir", verá que el jar SDK se ha agregado a su ruta de compilación.

sdkJar

Selecciona Finalizar.

Su nuevo proyecto ahora se ha agregado a su vista Explorador de paquetes.

createSrcPackage

Expanda el paquete haciendo clic en la flecha a la izquierda, haga clic derecho en la carpeta "src" y vaya a Nuevo -> Paquete . Ingrese lo que desea para el nombre del paquete. Ingresé "com.esignlive.example". Selecciona Finalizar.

createSrcPackage

Haga clic derecho en su nuevo paquete en el Explorador de paquetes y vaya a Nuevo -> Archivo para crear un nuevo archivo java. Ingrese un nombre para el archivo. Llamé al archivo "SimpleCreateAndSendPackage.java". Selecciona Finalizar.

Finalmente, agregue un archivo PDF de muestra que desee haber firmado en su proyecto con una simple copia y pegue desde su sistema de archivos en su proyecto en el explorador de paquetes. Utilicé BIRT (proyecto de informes Eclipse) para crear el PDF de acuerdo de muestra que se usa en este blog.

Esto completa la instalación y configuración. Su proyecto ahora debería verse así:

Proyecto configurado

Ahora está listo para escribir el código en su clase Java.

El código

Abra su archivo "SimpleCreateAndSendPackage.java" en Eclipse. Copie el siguiente código en el editor de archivos. Discutiremos el código con más detalle, más abajo.

paquete com.esignlive.example;

import com.silanis.esl.sdk.DocumentPackage;
import com.silanis.esl.sdk.EslClient;
import com.silanis.esl.sdk.PackageId;
import com.silanis.esl.sdk.SessionToken;
 
importar estática com.silanis.esl.sdk.builder.DocumentBuilder.newDocumentWithName;
importar estática com.silanis.esl.sdk.builder.PackageBuilder.newPackageNamed;
importar estática com.silanis.esl.sdk.builder.SignatureBuilder.signatureFor;
importar estática com.silanis.esl.sdk.builder.SignerBuilder.newSignerWithEmail;
 
clase pública SimpleCreateAndSendPackage {
 
    Cadena pública estática final API_KEY = "";
    public static final String API_URL = "https://sandbox.esignlive.com/api"; 
    // USE https://apps.e-signlive.com/api PARA LA PRODUCCIÓN
 
    public static void main (String [] args) {
        EslClient eslClient = nuevo EslClient (API_KEY, API_URL);
        // Construye el objeto DocumentPackage
        DocumentPackage documentPackage = newPackageNamed ("Test Package API")
                .withSigner (newSignerWithEmail ("signers.email @example .com ")
                        .withCustomId ("Firmante")
                        .withFirstName ("SignerFirstName")
                        .withLastName ("SignerLastName"))
                .withSigner (newSignerWithEmail ("your.email @example .com ")
                        .withFirstName ("YourFirstName")
                        .withLastName ("YourLastName"))
                .withDocument (newDocumentWithName ("sampleAgreement")
                        .fromFile ("sampleAgreement.pdf")
                        .withSignature (signatureFor ("signers.email @example .com ")
                                .onPage (0)
                                .atPosition (175, 165))
                        .withSignature (signatureFor ("your.email @example .com ")
                        		.onPage (0)
                        		.atPosition (550, 165)))
                .construir();
 
        // Emita la solicitud al servidor OneSpan Sign para crear el DocumentPackage
        PackageId packageId = eslClient.createPackage (documentPackage);
 
        // Enviar el paquete para ser firmado por los participantes
        eslClient.sendPackage (packageId);
    }
}

Verá en la primera línea de la clase que necesitará su clave API. Para encontrar esto, inicie sesión en su cuenta de OneSpan Sign y haga clic en "CUENTA" en el menú superior. Su clave de API se enumera allí. Por defecto, el valor está oculto. Seleccione "Desbloquear" para mostrar el valor. Ahora, reemplace con su valor clave API.

La siguiente línea es la API_URL. Si está utilizando Sandbox, como yo, la URL correcta ya está en su lugar. Si está en producción, debe usar la URL comentada.

Debido a que este es un ejemplo muy básico, el resto del código también está dentro del método principal.

EslClient eslClient = nuevo EslClient (API_KEY, API_URL);

La línea de código anterior crea nuestro Cliente OneSpan Sign utilizando la Clave API de su cuenta OneSpan Sign y la URL API apropiada que definió anteriormente.

El siguiente bloque de código es donde realmente crea el paquete de documentos. Dentro de este bloque, le da un nombre a su paquete.

DocumentPackage documentPackage = newPackageNamed ("Test Package API")

A continuación, se agregan dos firmantes al paquete. Uno es usted mismo y el otro es la persona a la que enviará el paquete para su firma. En este bloque, reemplazará las direcciones de correo electrónico y los nombres con su información de prueba.

.withSigner (newSignerWithEmail ("signers.email @example .com ")
        .withCustomId ("Firmante")
        .withFirstName ("SignerFirstName")
        .withLastName ("SignerLastName"))
.withSigner (newSignerWithEmail ("your.email @example .com ")
        .withFirstName ("YourFirstName")
        .withLastName ("YourLastName"))

Agregamos nuestro documento para firmar y también colocamos los bloques de firma para nuestros firmantes. Nuevamente, recuerde reemplazar los valores de muestra en este bloque con su información de prueba.

.withDocument (newDocumentWithName ("sampleAgreement")
        .fromFile ("sampleAgreement.pdf")
        .withSignature (signatureFor ("signers.email @example .com ")
                .onPage (0)
                .atPosition (175, 165))
        .withSignature (signatureFor ("your.email @example .com ")
                .onPage (0)
                .atPosition (550, 165)))

Finalmente, construimos nuestro paquete.

.construir();

Ahora que el objeto del paquete de documentos está listo, podemos acceder a nuestro Cliente OneSpan Sign, crear nuestro paquete y enviarlo a los firmantes.

// Emita la solicitud al servidor OneSpan Sign para crear el DocumentPackage
PackageId packageId = eslClient.createPackage (documentPackage);
 
// Enviar el paquete para ser firmado por los participantes
eslClient.sendPackage (packageId);

Ejecutando el Código

Con su clase de Java completada, puede seguir adelante y ejecutar su aplicación simple. Hay algunas formas de hacerlo desde Eclipse. En la barra de herramientas, puede seleccionar el botón Ejecutar, puede seleccionar Ejecutar -> Ejecutar desde la barra de menú, o puede hacer clic derecho en su clase de Java en el Explorador de paquetes y elegir Ejecutar como -> Aplicación Java .

¡Felicidades! Ahora ha creado y enviado un paquete con el SDK de Java. Si revisa nuestra bandeja de entrada de la cuenta de OneSpan Sign Sandbox, verá que el paquete se ha creado y espera la firma.

bandeja de entrada

¡Gracias por leer! Si tiene preguntas, no dude en publicar preguntas en la sección de comentarios. La próxima vez, continuaré con lo que sucede a continuación con este paquete, como mostrar cómo verificar el estado de un paquete y descargar el paquete completo. Si desea avanzar y jugar un poco más con las API, eche un vistazo a la documentación y los ejemplos disponibles. Encontrará enlaces en la ubicación donde descargamos el SDK, arriba. Los enlaces a todas las publicaciones de esta serie de blogs se pueden encontrar a continuación.

- Michael Williams
Gorjeo El | Facebook El | LinkedIn

 

OneSpan Sign for New Users Serie de blogs

desarrollador e-Sign firma electrónica Eclipse Java paquete salvadera tutorial
Michael Williams
Volver arriba