Para descargar la muestra de código completa, consulte nuestro sitio Code Share. Para obtener información sobre el uso de Extracción de posiciones con Campos condicionales, consulte Extracción de posiciones + Campos condicionales.
La función de extracción de posición garantiza que la posición y el tamaño exactos de un campo o una firma en un archivo PDF cargado se conservan automáticamente en OneSpan Sign.
El siguiente código de ejemplo muestra cómo editar el objeto de bloque de documento con extracción de posición.
Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.
.withDocument(newDocumentWithName("First Document") .fromFile("DOC_FILE_PATH") .enableExtraction() .withSignature(signatureFor("[email protected]") .withName("sig1") .withPositionExtracted()) )
Asegúrese de que la llamada enableExtraction() esté configurada a nivel de documento y que el documento PDF contenga un campo llamado sig1. De lo contrario, se producirá un error.
Resultados
A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
La función de extracción de posición garantiza que la posición y el tamaño exactos de un campo o una firma en un archivo PDF cargado se conservan automáticamente en OneSpan Sign.
El siguiente código de ejemplo muestra cómo editar el objeto de bloque de documento con extracción de posición.
Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.
.WithDocument(DocumentBuilder.NewDocumentNamed("First Document") .FromFile("C:/Users/hhaidary/Desktop/pdf/working.pdf") .EnableExtraction() .WithSignature(SignatureBuilder.SignatureFor("[email protected]") .WithName("sig1") .WithPositionExtracted()) )
Asegúrese de que la llamada enableExtraction() esté configurada a nivel de documento y que el documento PDF contenga un campo llamado sig1. De lo contrario, se producirá un error.
Resultados
A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
La función de extracción de posición garantiza que la posición y el tamaño exactos de un campo o una firma en un archivo PDF cargado se conservan automáticamente en OneSpan Sign.
El siguiente código de ejemplo muestra cómo editar el objeto de bloque de documento con extracción de posición.
Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.
Solicitud HTTP
POST /api/packages
Encabezados HTTP
Accept: application/json Content-Type: multipart/form-data Authorization: Basic api_key
Carga útil de solicitud
------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf" Content-Type: application/pdf %PDF-1.5 %µµµµ 1 0 obj <>>> endobj.... ------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="payload" { "roles": [ { "id": "Signer1", "type": "SIGNER", "signers": [ { "firstName": "John", "lastName": "Smith", "email": "[email protected]" } ], "name": "Signer1" } ], "documents": [ { "approvals": [ { "fields": [ { "type": "INPUT", "extract": true, "subtype": "LABEL", "name": "name1", "binding": "{signer.name}" }, { "type": "INPUT", "extract": true, "subtype": "TEXTFIELD", "name": "age1" }, { "type": "INPUT", "extract": true, "subtype": "TEXTFIELD", "name": "address1" }, { "type": "INPUT", "extract": true, "subtype": "TEXTFIELD", "name": "zip1" }, { "type": "INPUT", "extract": true, "subtype": "TEXTFIELD", "name": "city1" }, { "type": "SIGNATURE", "extract": true, "subtype": "FULLNAME", "name": "sig1" } ], "role": "Signer1" } ], "extract": true, "name": "Sample Contract" } ], "name": "Field Position Extraction Example", "type": "PACKAGE", "language": "en", "autoComplete": true, "status": "DRAFT" } ------WebKitFormBoundary1bNO60n7FqP5WO4t--
Asegúrese de que la llamada “extract” : true esté configurada a nivel de documento y que el documento PDF contenga un campo llamado name1, age1, address1, zip1, city1 y sig1. Si no lo hace, se producirá un error.
Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.
Carga útil de respuesta
{ "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI=" }
Resultados
A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.
Tabla de carga útil de solicitud
Propiedad | Tipo | Editable | Obligatorio | Predeterminado | Valores de ejemplo | ||
---|---|---|---|---|---|---|---|
status | string | Sí | No | BORRADOR | BORRADOR / ENVIADO / COMPLETADO / ARCHIVADO / RECHAZADO / ELEGIR NO HACERLO / CADUCÓ | ||
autoComplete | boolean | Sí | No | true | true / false | ||
type | string | Sí | No | PAQUETE | PAQUETE / FORMULARIO / FORMATO | ||
name | string | Sí | Sí | n/a | Ejemplo de extracción de posición de campo | ||
documents | |||||||
name | string | Sí | No | n/a | Ejemplo de contrato | ||
extract | boolean | Sí | No | false | true / false | ||
approvals | |||||||
role | string | Sí | No | n/a | Signer1 | ||
fields | |||||||
type | string | Sí | Sí | n/a | FIRMA / ENTRADA | ||
extract | boolean | Sí | No | false | true / false | ||
subtype | string | Sí | Sí | n/a | NOMBRE COMPLETO / INICIALES / CAPTURA / CAPTURA_MÓVIL / ETIQUETA / CAMPO DE TEXTO / ÁREA DE TEXTO / CASILLA DE VERIFICACIÓN / FECHA / RADIO / LISTA | ||
name | string | Sí | No | n/a | sig1 | ||
value | string | Sí | No | n/a | NOMBRE COMPLETO / INICIALES / CAPTURA / ETIQUETA / CAMPO DE TEXTO / ÁREA DE TEXTO / CASILLA DE VERIFICACIÓN / RADIO / LISTA | ||
binding | string | Sí | No | null | {approval.signed} / {signer.title} / {signer.name} / {signer.company} | ||
roles | |||||||
id | string | Sí | No | n/a | Signer1 | ||
name | string | Sí | No | n/a | Remitente | ||
type | string | Sí | No | FIRMANTE | FIRMANTE / REMITENTE | ||
signers | |||||||
string | Sí | Sí | n/a | [email protected] | |||
firstName | string | Sí | Sí | n/a | Ernesto | ||
lastName | string | Sí | Sí | n/a | Puente |
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
La función de extracción de posición garantiza que la posición y el tamaño exactos de un campo o una firma en un archivo PDF cargado se conservan automáticamente en OneSpan Sign.
El siguiente código de ejemplo muestra cómo editar el objeto de bloque de documento con extracción de posición.
Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.
//Prepare Documents Blob String document1Name = 'Sample_Position_Extraction'; StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'test_position_extraction' LIMIT 1]; Map<String,Blob> documentBlobMap = new Map<String,Blob>(); documentBlobMap.put(document1Name, sr.Body); //Create Document Metadata ESignLiveAPIObjects.Document document1 = new ESignLiveAPIObjects.Document(); document1.name = document1Name; document1.id = document1Name; document1.extract = true; //document level extraction:true ESignLiveAPIObjects.Approval approval1 = new ESignLiveAPIObjects.Approval(); approval1.role = roleId1; approval1.id = 'approval1'; ESignLiveAPIObjects.Field field1 = new ESignLiveAPIObjects.Field(); field1.id = 'signature1'; field1.extract = true; field1.name = 'sig1'; //match pdf field property name field1.type = 'SIGNATURE'; field1.subtype = 'FULLNAME'; approval1.fields = new List<ESignLiveAPIObjects.Field>{field1}; document1.approvals = new List<ESignLiveAPIObjects.Approval>{approval1}; pkg.documents = new List<ESignLiveAPIObjects.Document>{document1}; //add document
Asegúrese de que la llamada enableExtraction() esté configurada a nivel de documento y que el documento PDF contenga un campo llamado sig1. De lo contrario, se producirá un error.
Resultados
A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.