Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Un campo personalizado
Un campo que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. es aquel que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. Por ejemplo, puede que un firmante tenga un número de agente y ese número deba aparecer en el documento final junto a su firma. Con un campo personalizado, el firmante puede especificar su número de agente y ese número aparecerá automáticamente en cualquier otro campo que haya sido configurado para recibirlo.
La página Campos personalizados le permite administrar los campos personalizados de su cuenta.
Esta funcionalidad solo está disponible si los campos personalizados están activados en el nivel de cuenta. Póngase en contacto con nuestro Equipo de asistencia para habilitarlos.
Crear un campo personalizado
Para crear un campo personalizado, deberá crear un objeto CustomField . Cada campo personalizado que cree se identifica por el id único que establece durante este proceso. Use el siguiente código para hacerlo:
La creación de otro campo personalizado con el mismo id sobrescribirá el campo personalizado original. Además, tenga en cuenta que cada campo personalizado que cree lo hará para toda la cuenta.
String customFieldId1 = "policy_number_id"; CustomField customField = CustomFieldBuilder.customFieldWithId(customFieldId1) .withDefaultValue("123-456-789-0") .withTranslation(newTranslation("en") .withName("Policy Number") .withDescription("Car Insurance Policy Number.")) .build(); eslClient.getCustomFieldService().createCustomField(customField);
El withDefaultValue() es el valor que aparece después de que el firmante haya firmado el documento. Este método es necesario cuando se crea un campo personalizado.
Los campos personalizados también contienen una colección de traducciones que se utilizan al mostrar el campo personalizado a los miembros de la cuenta.
Este consejo es para cuentas que admiten varios idiomas. Como práctica recomendada, todos los campos personalizados que necesite deben replicarse para cada idioma admitido en su cuenta. El sistema solo mostrará el campo personalizado en el idioma seleccionado por el usuario activo. Si no se asigna un idioma a un campo personalizado, será el inglés de forma predeterminada, independientemente del idioma seleccionado por el usuario activo.
Se requiere al menos una traducción al construir su objeto CustomField. Utilice OneSpan Sign CustomFieldService para crear su campo personalizado.
Recuperar campos personalizados
Puede recuperar sus campos personalizados con OneSpan Sign CustomFieldService. Puede recuperar todos los campos personalizados, que se le devuelven como una lista, o recuperar uno específico utilizando el id de campo personalizado. Use el siguiente código para hacerlo:
// Get the entire list of custom field from account List<CustomField> retrieveCustomFieldList1 = eslClient.getCustomFieldService().getCustomFields(Direction.ASCENDING); // Get the first custom field from account CustomField retrieveCustomField = eslClient.getCustomFieldService().getCustomField(customFieldId1);
Borrar un campo personalizado
La eliminación de un campo personalizado de su cuenta también se realiza con OneSpan Sign CustomFieldService. Use el siguiente código para hacerlo:
// Delete the second custom field from account eslClient.getCustomFieldService().deleteCustomField(customFieldId1);
Editar un bloque de firma para agregar campos personalizados
Para editar el bloque de firmas para agregar códigos personalizados, utilice el siguiente código. En este ejemplo, los delimitadores de texto se utilizan para posicionar tanto los campos de firma como los personalizados. Para obtener más información, consulte Delimitadores de texto.
.withSignature(signatureFor(email1) .withPositionAnchor(TextAnchorBuilder.newTextAnchor("Client Signature") .atPosition(TextAnchorPosition.TOPLEFT) .withOccurence(0) .withCharacter(16) .withSize(250, 70) .withOffset(20, -58)) .withField(FieldBuilder.customField(customField.getId()) .withPositionAnchor(TextAnchorBuilder.newTextAnchor("Policy Number") .atPosition(TextAnchorPosition.TOPLEFT) .withOccurence(0) .withCharacter(13) .withSize(250, 25) .withOffset(20, -10))))
Resultados
Una vez que haya ejecutado su código, encontrará que sus campos personalizados se pueden ver en su cuenta OneSpan Sign. Estos campos personalizados también estarán disponibles para su uso en transacciones. Para más información, consulte Campos personalizados .
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Un campo personalizado Un campo que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. es aquel que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. Por ejemplo, puede que un firmante tenga un número de agente y ese número deba aparecer en el documento final junto a su firma. Con un campo personalizado, el firmante puede especificar su número de agente y ese número aparecerá automáticamente en cualquier otro campo que haya sido configurado para recibirlo.
La página Campos personalizados le permite administrar los campos personalizados de su cuenta.
Esta funcionalidad solo está disponible si los campos personalizados están activados en el nivel de cuenta. Póngase en contacto con nuestro Equipo de asistencia para habilitarlos.
Crear un campo personalizado
Para crear un campo personalizado, deberá crear un objeto CustomField . Cada campo personalizado que cree se identifica por el id único que establece durante este proceso. Use el siguiente código para hacerlo:
La creación de otro campo personalizado con el mismo id sobrescribirá el campo personalizado original. Además, tenga en cuenta que cada campo personalizado que cree lo hará para toda la cuenta.
String customFieldId1 = "policy_number_id"; CustomField customField = CustomFieldBuilder.CustomFieldWithId(customFieldId1) .WithDefaultValue("123-456-789-0") .WithTranslation(TranslationBuilder.NewTranslation("en") .WithName("Policy Number") .WithDescription("Car Insurance Policy Number.")) .Build(); eslClient.GetCustomFieldService().CreateCustomField(customField);
El withDefaultValue() es el valor que aparece después de que el firmante haya firmado el documento. Este método es necesario cuando se crea un campo personalizado.
Los campos personalizados también contienen una colección de traducciones que se utilizan al mostrar el campo personalizado a los miembros de la cuenta.
Este consejo es para cuentas que admiten varios idiomas. Como práctica recomendada, todos los campos personalizados que necesite deben replicarse para cada idioma admitido en su cuenta. El sistema solo mostrará el campo personalizado en el idioma seleccionado por el usuario activo. Si no se asigna un idioma a un campo personalizado, será el inglés de forma predeterminada, independientemente del idioma seleccionado por el usuario activo.
Se requiere al menos una traducción al construir su objeto CustomField. Utilice OneSpan Sign CustomFieldService para crear su campo personalizado.
Recuperar campos personalizados
Puede recuperar sus campos personalizados conOneSpan Sign CustomFieldService. Puede recuperar todos los campos personalizados, que se le devuelven como una lista, o recuperar uno específico utilizando el id de campo personalizado. Use el siguiente código para hacerlo:
// Get the entire list of custom field from account IList<CustomField> retrieveCustomFieldList1 = eslClient.GetCustomFieldService().GetCustomFields(Direction.ASCENDING); // Get the first custom field from account CustomField retrieveCustomField = eslClient.GetCustomFieldService().GetCustomField(customFieldId1);
Borrar un campo personalizado
La eliminación de un campo personalizado de su cuenta también se realiza con OneSpan Sign CustomFieldService. Use el siguiente código para hacerlo:
// Delete the second custom field from account eslClient.GetCustomFieldService().DeleteCustomField(customFieldId1);
Editar un bloque de firma para agregar campos personalizados
Para editar el bloque de firmas para agregar códigos personalizados, utilice el siguiente código. En este ejemplo, los delimitadores de texto se utilizan para posicionar tanto los campos de firma como los personalizados. Para obtener más información, consulte Delimitadores de texto.
.WithSignature(SignatureBuilder.SignatureFor(email1) .WithPositionAnchor(TextAnchorBuilder.NewTextAnchor("Client Signature") .AtPosition(TextAnchorPosition.TOPLEFT) .WithOccurrence(0) .WithCharacter(16) .WithSize(250, 70) .WithOffset(20, -58)) .WithField(FieldBuilder.CustomField(customField.Id) .WithPositionAnchor(TextAnchorBuilder.NewTextAnchor("Policy Number") .AtPosition(TextAnchorPosition.TOPLEFT) .WithOccurrence(0) .WithCharacter(13) .WithSize(250, 25) .WithOffset(20, -10))))
Resultados
Una vez que haya ejecutado su código, encontrará que sus campos personalizados se pueden ver en su cuenta OneSpan Sign. Estos campos personalizados también estarán disponibles para su uso en transacciones. Para más información, consulte Campos personalizados .
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Un campo personalizado Un campo que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. es aquel que, en el momento de la firma, se rellena automáticamente con datos específicos del firmante. Por ejemplo, puede que un firmante tenga un número de agente y ese número deba aparecer en el documento final junto a su firma. Con un campo personalizado, el firmante puede especificar su número de agente y ese número aparecerá automáticamente en cualquier otro campo que haya sido configurado para recibirlo.
La página Campos personalizados le permite administrar los campos personalizados de su cuenta.
Esta funcionalidad solo está disponible si los campos personalizados están activados en el nivel de cuenta. Póngase en contacto con nuestro Equipo de asistencia para habilitarlos.
Crear un campo personalizado
Cada campo personalizado que cree se identifica por el id único que establece durante este proceso. En el JSON a continuación, el objeto value es el valor que aparece después de que el firmante haya firmado el documento. Este campo es obligatorio al crear un campo personalizado.
La creación de otro campo personalizado con el mismo id sobrescribirá el campo personalizado original. Además, tenga en cuenta que cada campo personalizado que cree lo hará para toda la cuenta.
Para crear un campo personalizado, deberá realizar la siguiente solicitud:
Solicitud HTTP
POST /api/account/customfields
Encabezados HTTP
Accept: application/json Content-Type: application/json Authorization: Basic api_key
Carga útil de solicitud
{ "id":"policy_number_id", "value":"123-456-789-0", "required":false, "translations":[ { "language":"en", "name":"Policy Number", "description":"Car Insurance Policy Number." } ] } Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente. Carga útil de respuesta
{ "dirtyFields": [ "translations", "id", "value", "required" ], "required": false, "id": "policy_number_id", "data": null, "translations": [ { "dirtyFields": [ "name", "description", "language" ], "description": "Car Insurance Policy Number.", "language": "en", "id": "", "data": null, "name": "Policy Number" } ], "value": "123-456-789-0", "name": "" } Los campos personalizados también contienen una colección de traducciones que se utilizan al mostrar el campo personalizado a los miembros de la cuenta.
Este consejo es para cuentas que admiten varios idiomas. Como práctica recomendada, todos los campos personalizados que necesite deben replicarse para cada idioma admitido en su cuenta. El sistema solo mostrará el campo personalizado en el idioma seleccionado por el usuario activo. Si no se asigna un idioma a un campo personalizado, será el inglés de forma predeterminada, independientemente del idioma seleccionado por el usuario activo.
Recuperar campos personalizados
Puede recuperar todos sus campos personalizados haciendo una solicitud GET a:
https://sandbox.esignlive.com/api/account/customfields.
O bien, puede recuperar un campo personalizado específico utilizando su ID personalizado en su solicitud GET :
https://sandbox.esignlive.com/api/account/customfields/{customFieldId}
Borrar un campo personalizado
La eliminación de un campo personalizado de su cuenta se realiza realizando una solicitud de ELIMINACIÓN para:
https://sandbox.esignlive.com/api/account/customfields/{customFieldId}
Editar un bloque de firma para agregar campos personalizados
Para editar el bloque de firmas para agregar códigos personalizados, utilice el siguiente código. En este ejemplo, los delimitadores de texto se utilizan para posicionar tanto los campos de firma como los personalizados. Para obtener más información, consulte Delimitadores de texto.
{ "approvals": [ { "fields": [ { "type": "SIGNATURE", "extract": true, "extractAnchor": { "text": "Client Signature", "index": 0, "width": 250, "height": 70, "anchorPoint": "TOPLEFT", "characterIndex": 16, "leftOffset": 20, "topOffset": -58 }, "subtype": "FULLNAME" }, { "type": "INPUT", "extract": true, "extractAnchor": { "text": "Policy Number", "index": 0, "width": 250, "height": 25, "anchorPoint": "TOPLEFT", "characterIndex": 13, "leftOffset": 20, "topOffset": -10 }, "subtype": "CUSTOMFIELD", "name": "policy_number_id" } ], "role": "Signer1" }, { "fields": [ { "type": "SIGNATURE", "extract": true, "extractAnchor": { "text": "Manager Signature", "width": 250, "height": 70, "index": 0, "anchorPoint": "TOPLEFT", "characterIndex": 17, "leftOffset": 20, "topOffset": -58 }, "subtype": "FULLNAME" }, { "type": "INPUT", "top": 50, "left": 50, "height": 50, "width": 250, "subtype": "CUSTOMFIELD", "name": "agent_number_id" } ], "role": "Signer2" } Resultados
Una vez que haya ejecutado su código, encontrará que sus campos personalizados se pueden ver en su cuenta OneSpan Sign. Estos campos personalizados también estarán disponibles para su uso en transacciones. Para más información, consulte Campos personalizados .
Tabla de carga útil de solicitud
| Propiedad | Tipo | Editable | Obligatorio | Predeterminado | Valores de ejemplo |
|---|---|---|---|---|---|
| id | string | sí | no | n/a | policy_number_id |
| value | string | sí | no | n/a | 123-456-789-0 |
| required | boolean | sí | no | false | false / true |
| translations | |||||
| language | string | sí | no | en | en / fr / es ... |
| name | string | sí | no | n/a | Número de póliza |
| description | string | sí | no | n/a | Número de póliza de seguro de coche |