Si has llegado hasta aquí, ya debes haberlo sabido. zapsign y tu maravilloso documentación, pero debe haber pensado: ¿existe una manera más fácil de integrar ZapSign con SDK en Java? La respuesta a esa pregunta es SIM!
¡Sigue leyendo este artículo para descubrir cómo funciona y cómo ponerlo en práctica!
¿Qué es un SDK y cómo puede ayudar?
Al integrarse con Zapsign, debe crear un JSON con los datos necesarios y realizar una solicitud a nuestra api. Pero, ¿qué debería haber en ese JSON? ¿Cómo debo enviar esta solicitud?
La respuesta está en el Software Development Kit (o kit de desarrollo de software), es decir, un conjunto de herramientas desarrolladas para ayudar a los desarrolladores a crear aplicaciones.
Nuestro SDK te hará todas estas preguntas más sencillas, ya que te proporcionamos todo lo que necesitas para utilizar nuestra aplicación de forma clara y sencilla.
Bien, pero ¿cómo hacerlo?
Para comenzar, primero necesitamos una aplicación Java Maven. Cuando use IntelliJ, simplemente siga el comando Archivo/Nuevo/Proyecto y cree este proyecto con Maven Archetype, como se muestra en la siguiente captura de pantalla.
Con el proyecto terminado, necesitamos incluir el confianza en Zapsign en el .pom del proyecto:
com.zapsign
zapsign_sdk
1.0-3
Recuerde agregar siempre la versión más actual.
Con eso, estás listo para usar todas las funcionalidades.
Paso a paso para la integración de Java SDK
Pongamos que tienes un contrato en PDF en la nube y quieres enviárselo a dos personas para que lo firmen. ¿Cómo traducir esto a nuestro SDK? Consulte los siguientes pasos para averiguarlo.
1. Cree el documento
Hemos tratado de dar los nombres más intuitivos a cada característica. Entonces, si desea crear un documento a través de la carga de PDF, la clase utilizada es DocFromPdf.
Aquí estamos construyendo un documento en modo producción (sandbox = false), con el nombre “Mi Contrato”, idioma “pt-br” y el siguiente enlace al PDF:
Pero, todo contrato necesita suscriptores, ¿correcto? Para ello construiremos objetos de la clase Signo y lo mantendremos en una lista.
Con eso, pudimos crear dos firmantes: uno más simple, con solo el nombre, y otro con más datos.
Para todas las opciones de firmantes, eche un vistazo a nuestra documentación. Al final, agregamos estos suscriptores a una lista y los incluimos en la creación del documento.
Hasta ahora tenemos todos los datos necesarios para crear el documento en Zapsign, pero necesitamos saber con qué cuenta vamos a crear este documento.
2. Configurar la autenticación
Necesitamos su token api de su cuenta de Zapsign. Así que entra zapsign.com.br, inicie sesión en su cuenta, ingrese la configuración y seleccione el subelemento Integración.
Recuerde que solo los administradores y propietarios de cuentas tienen acceso a la configuración.
Guardemos este token en nuestro código para usarlo más tarde:
Con este token, ya sabemos cuál es tu cuenta. Pero aún necesitamos enviar este documento a nuestra API.
3. Enviar los datos del documento para su firma
En este último paso, necesitamos hacer una solicitud al enviar todo lo que hemos creado. Para esto, ya hemos preparado la clase. Solicitudes de documentos que contiene todos los métodos relacionados con la creación, eliminación, edición y listado de documentos.
Para nuestro caso específico, utilizaremos el método crearDocFromUploadPdf, agregando su token de cuenta y el documento creado anteriormente.
Este método ya creará el documento en su cuenta y devolverá todos los datos en una clase llamada RespuestaDoc. En este ejemplo convertimos esta clase en JSON, a través de la JsonConvertidor, solo para imprimir en la pantalla. Pero, puedes usar la clase como quieras.
Esta respuesta contiene datos importantes, como el identificador único del documento en Zapsign y los datos del firmante.
¿Cuáles son los siguientes pasos?
Ahora que ha entendido los tres pasos necesarios para comenzar con la integración, veamos qué debe hacer a continuación.
¿Qué hacer con la respuesta?
Muchos clientes tienen la necesidad de enviar su propio correo electrónico a los suscriptores. Para ello, podemos utilizar la siguiente idea:
Dentro de la respuesta, podemos recorrer todos los firmantes usando un for en el docResponse.getSigners() y enviar un correo electrónico desde su propia aplicación. Luego simplemente pasamos el enlace a la Assinatura, que se guarda dentro del firmante.getSign_url().
Este es solo uno de los muchos ejemplos que podemos hacer con datos en nuestra aplicación. Ahora es el momento de dejar volar tu imaginación.
Webhooks
Bien, logramos hacer un documento. Pero, necesitamos saber cuándo un firmante firmó el documento, ¿verdad?
Pues bien, la aplicación Zapsign tiene tres webhooks listos para usar: uno al crear documentos, otro al firmar firmantes y el último cuando se elimina un documento.
Tenemos una parte específica para explicar cómo configurar webhook en nuestra documentación.
Otras solicitudes
Además de crear un documento vía PDF en la nube, es posible realizar varias funcionalidades. Todos ellos están listados y ejemplificados en nuestro Documentación SDK.
ejemplo de código
paquete org.ejemplo.pruebas.docs;
cuerpo de importación.doc.DocFromPdf;
importar cuerpo.firmante.Firmante;
importar documentos.DocRequests;
importar respuesta.DocResponse;
servicios de importación.JsonConverter;
importar java.io.IOException;
importar java.util.ArrayList;
clase pública CreateDocFromUploadPdf {
public static void main(String[] args) lanza IOException, InterruptedException {
String apiToken = "0a4d6893-f431-4d83-af80-...";
Firmante firmante1 = Firmante.constructor()
.name("Mi primer firmante")
.construir();
Firmante firmante2 = Firmante.constructor()
.name("Mi segundo firmante")
.correo electrónico("[email protected]")
.lock_email (verdadero)
.lock_phone (verdadero)
.phone_country("55")
.phone_number("99999999999")
.auth_mode("signatureScreen")
.send_automatic_email (falso)
.send_automatic_whatsapp (falso)
.construir();
lista de arreglo firmantes = new ArrayList<>();
firmantes.add(firmante1);
firmantes.add(firmante2);
DocFromPdf docFromPdf = DocFromPdf.docFromPdfBuilder()
.sandbox (falso)
.name("Mi contrato")
.brand_primary_color("#000000")
.lang("pt-br")
.firmantes(firmantes)
.url_pdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
.construir();
tratar {
DocResponse docResponse = new DocRequests(apiToken).createDocFromUploadPdf(docFromPdf);
Cadena jsonDocResponse = new JsonConverter().docResponseToJson(docResponse);
System.out.println(jsonDocResponse);
}
catch(Excepción excepciónError) {
System.out.println(exceptionError.getMessage());
}
}
}
Consideraciones finales
Una integración entre dos aplicaciones suele ser una tarea laboriosa, pero espero que nuestro SDK facilite su trabajo. Si necesita ayuda o desea comentar cómo está utilizando esta herramienta, deje un comentario aquí.
¿Te gustó la integración, pero aún no conoces Zapsign? ¡Arreglemos esto entonces! Para ver lo que Zapsign tiene para ofrecer a su empresa, solicitar un recorrido en nuestra plataforma con uno de nuestros asistentes!
