OneSpan Sign Cómo: inyectar campos
Con OneSpan Sign, puede personalizar su documento. Una de las muchas maneras de hacerlo es con la inyección de campo. Esta característica estampa los valores directamente en el documento durante la carga del documento. Por ejemplo, un firmante puede tener un número de agente, y ese número de agente debe aparecer en el documento final junto a su firma. Al inyectar el número de agente de un firmante en el documento, este nuevo texto pasará a formar parte del documento subyacente y no podrá ser manipulado.
Para habilitar la inyección de campo, necesitará un PDF con campos de formulario. Además, los nombres de los campos de su formulario en su PDF deben ser los mismos que los nombres de los campos inyectados en su código. Tenga en cuenta que actualmente la inyección de datos en un documento, utilizando OneSpan Sign, solo se puede hacer al cargar su documento y solo a través de API / SDK. En este blog, le mostraré cómo usar los campos inyectados con Java SDK, .NET SDK y REST API.
El código
Con nuestro conjunto de objetivos, puede continuar y pasar a la sección que se aplica a su método. Cubriré exactamente el mismo contenido en cada segmento. El código completo para este blog se puede encontrar en el Código de comunidad de desarrolladores Compartir: Java , .RED y DESCANSO .
SDK de Java
Comenzaré con el SDK de Java. En mi ejemplo, elegí inyectar campos de texto ya que esto es probablemente lo que terminarás haciendo. Sin embargo, puede inyectar cualquier tipo de campo independiente que desee. Puede encontrar una lista completa de los campos no vinculados de OneSpan Sign aquí . El siguiente código de muestra muestra cómo editar el bloque de documentos para inyectar campos de texto. los withName () El método es donde ingresa el nombre del campo de formulario PDF en el que desea inyectar texto, como se nombra en su formulario PDF. los withValue () El método es el texto que desea estampar en su documento. Si necesita una comparación con la creación básica de objetos de documento o si es la primera vez que crea un paquete con el SDK de Java, consulte esto Blog .
.withDocument (DocumentBuilder.newDocumentWithName ("Contrato de muestra")
.enableExtraction ()
.fromStream (fs, DocumentType.PDF)
.withInjectedField (FieldBuilder.textField ()
.withName ("Texto1")
.withValue ("200 E MAIN ST, PHOENIX AZ, 85123 USA"))
.withInjectedField (FieldBuilder.textField ()
.withName ("Texto2")
.withValue ("Cortacésped"))
.withInjectedField (FieldBuilder.textField ()
.withName ("Texto3")
.withValue ("Fertilizante"))
.withInjectedField (FieldBuilder.textField ()
.withName ("Texto4")
.withValue ("100"))
.withInjectedField (FieldBuilder.textField ()
.withName ("Texto5")
.withValue ("12 12 12")))
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 .NET SDK A continuación, cubriré el SDK de .NET. En mi ejemplo, elegí inyectar campos de texto ya que esto es probablemente lo que terminarás haciendo. Sin embargo, puede inyectar cualquier tipo de campo independiente que desee. Puede encontrar una lista completa de los campos no vinculados de OneSpan Sign aquí . El siguiente código de muestra muestra cómo editar el bloque de documentos para inyectar campos de texto. los withName () El método es donde ingresa el nombre del campo de formulario PDF en el que desea inyectar texto, como se nombra en su formulario PDF. los withValue () El método es el texto que desea estampar en su documento. Si necesita una comparación con la creación básica de objetos de documento o si es la primera vez que crea un paquete con el SDK de .NET, consulte esto Blog .
.WithDocument (DocumentBuilder.NewDocumentNamed ("contrato de muestra")
.EnableExtraction ()
.FromStream (fs, DocumentType.PDF)
.WithInjectedField (FieldBuilder.TextField ()
.WithId ("Texto1")
.WithName ("Texto1")
.WithValue ("200 E MAIN ST, PHOENIX AZ, 85123 USA"))
.WithInjectedField (FieldBuilder.TextField ()
.WithId ("Texto2")
.WithName ("Texto2")
.WithValue ("Cortacésped"))
.WithInjectedField (FieldBuilder.TextField ()
.WithId ("Texto3")
.WithName ("Texto3")
.WithValue ("Fertilizante"))
.WithInjectedField (FieldBuilder.TextField ()
.WithId ("Texto4")
.WithName ("Texto4")
.WithValue ("100"))
.WithInjectedField (FieldBuilder.TextField ()
.WithId ("Texto5")
.WithName ("Texto5")
.WithValue ("12 12 12"))
API REST
Finalmente, revisaré la API REST. Incluí el JSON que creará su paquete de documentos con campos de texto inyectados para mayor comodidad. En mi ejemplo, elegí inyectar campos de texto ya que esto es probablemente lo que terminarás haciendo. Sin embargo, puede inyectar cualquier tipo de campo independiente que desee. Puede encontrar una lista completa de los campos no vinculados de OneSpan Sign aquí . Además, tenga en cuenta que las casillas de verificación y los botones de opción son simplemente casillas de verificación con un valor "X" cuando se selecciona. El ejemplo de JSON a continuación muestra cómo editar el objeto del documento para inyectar campos de texto. En los campos objeto, el nombre El atributo es donde ingresa el nombre del campo de formulario PDF en el que desea inyectar texto. los valor El atributo es donde ingresa el texto que desea inyectar en su documento. Si necesita una comparación con la creación básica de objetos de documento o si es la primera vez que crea un paquete con la API REST, vea esto Blog .
{
"documentos": [
{
"campos": [
{
"valor": "200 E MAIN ST, PHOENIX AZ, 85123 USA",
"nombre": "Texto1"
},
{
"value": "Cortadora de césped",
"nombre": "Texto2"
},
{
"value": "Fertilizante",
"nombre": "Texto3"
},
{
"value": "100",
"nombre": "Texto4"
},
{
"valor": "12 12 12",
"nombre": "Texto5"
}
],
"extracto": verdadero,
"nombre": "Contrato de muestra"
}
],
"type": "PAQUETE",
"status": "BORRADOR",
"roles": [
{
"id": "cliente",
"índice": 0,
"type": "SIGNER",
"firmantes": [
{
"correo electrónico": "john.smith @example .com ",
"firstName": "John",
"apellido": "Smith",
"id": "cliente"
}
],
"nombre": "cliente"
},
{
"id": "contratista",
"índice": 1,
"type": "SENDER",
"firmantes": [
{
"correo electrónico": "myemail @example .com ",
"firstName": "Haris",
"lastName": "Haidary",
"id": "contratista"
}
],
"nombre": "contratista"
}
],
"name": "Ejemplo de inyección de campo"
}
Ejecutando su código
Una vez que haya ejecutado su código, si inicia sesión en OneSpan Sign, debe encontrar los campos de texto apropiados estampados en el documento en su paquete de documentos de OneSpan Sign, como se ve a continuación.
Si tiene preguntas 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: https://community.onespan.com . Eso es todo de mi parte. ¡Gracias por leer! Si esta publicación le parece útil, compártala en Facebook, Twitter o LinkedIn.
Haris Haidary
Evangelista Técnico Junior