Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Un champ personnalisé
Un champ qui, au moment de la signature, est automatiquement alimenté avec des données spécifiques au signataire. est un champ qui, au moment de la signature, est automatiquement rempli de données spécifiques au signataire. Par exemple, un signataire peut avoir un numéro d'agent, et ce numéro peut devoir apparaître dans le document final à côté de sa signature. En utilisant un champ personnalisé, le signataire peut spécifier son numéro d'agent, et ce numéro apparaîtra automatiquement dans tout autre champ qui a été configuré pour le recevoir.
La page Champs personnalisés vous permet de gérer les champs personnalisés de votre compte.
Cette fonctionnalité n'est disponible que si les champs personnalisés sont activés au niveau du compte. Veuillez communiquer avec notre équipe de soutien pour les faire activer.
Création d'un champ personnalisé
Pour créer un champ personnalisé, vous devez construire un objet CustomField . Chaque champ personnalisé que vous créez est identifié par l'identifiant unique que vous avez défini au cours de ce processus. Le code suivant permet d'effectuer ce qui suit :
La création d'un autre champ personnalisé avec le même identifiant écrasera le champ personnalisé d'origine. Notez également que chaque champ personnalisé que vous créez l'est pour l'ensemble du compte.
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);
La withDefaultValue() est la valeur qui apparaît après que votre signataire ait signé le document. Cette méthode est requise lors de la création d'un champ personnalisé.
Les champs personnalisés contiennent également une collection de traductions qui sont utilisées lors de l'affichage du champ personnalisé aux membres du compte.
Cette astuce concerne les comptes qui prennent en charge plusieurs langues. En tant que meilleure pratique, chaque champ personnalisé dont vous avez besoin doit être répliqué pour chaque langue prise en charge par votre compte. Le système n'affichera le champ personnalisé que dans la langue sélectionnée par l'utilisateur actif. Si un champ personnalisé n'est pas associé à une langue, celle-ci sera par défaut en anglais, quelle que soit la langue sélectionnée par l'utilisateur actif.
Au moins une traduction est requise lors de la construction de votre objet CustomField . Utilisez le OneSpan Sign CustomFieldService pour créer votre champ personnalisé.
Récupération des champs personnalisés
Vous pouvez récupérer vos champs personnalisés à l'aide de la fonction OneSpan Sign CustomFieldService. Vous pouvez soit récupérer tous les champs personnalisés, qui vous sont renvoyés sous forme de liste, soit récupérer un champ spécifique en utilisant l'identifiant du champ personnalisé. Le code suivant permet d'effectuer ce qui suit :
// 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);
Suppression d'un champ personnalisé
La suppression d'un champ personnalisé de votre compte se fait également à l'aide de la fonction OneSpan Sign CustomFieldService. Le code suivant permet d'effectuer ce qui suit :
// Delete the second custom field from account eslClient.getCustomFieldService().deleteCustomField(customFieldId1);
Modification d'un bloc de signature pour ajouter des champs personnalisés
Pour modifier le bloc de signature afin d'ajouter des codes personnalisés, utilisez le code suivant. Dans cet exemple, des ancres de texte sont utilisées pour positionner les champs de signature et les champs personnalisés. Pour obtenir plus d'informations, consultez Ancres de texte.
.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))))
Résultats
Une fois que vous aurez exécuté votre code, vous constaterez que vos champs personnalisés sont visibles dans votre compte OneSpan Sign. Ces champs personnalisés seront également disponibles pour être utilisés dans les transactions. Pour obtenir plus d'informations, consultez Champs personnalisés.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Un champ personnalisé Un champ qui, au moment de la signature, est automatiquement alimenté avec des données spécifiques au signataire. est un champ qui, au moment de la signature, est automatiquement rempli de données spécifiques au signataire. Par exemple, un signataire peut avoir un numéro d'agent, et ce numéro peut devoir apparaître dans le document final à côté de sa signature. En utilisant un champ personnalisé, le signataire peut spécifier son numéro d'agent, et ce numéro apparaîtra automatiquement dans tout autre champ qui a été configuré pour le recevoir.
La page Champs personnalisés vous permet de gérer les champs personnalisés de votre compte.
Cette fonctionnalité n'est disponible que si les champs personnalisés sont activés au niveau du compte. Veuillez communiquer avec notre équipe de soutien pour les faire activer.
Création d'un champ personnalisé
Pour créer un champ personnalisé, vous devez construire un objet CustomField . Chaque champ personnalisé que vous créez est identifié par l'identifiant unique que vous avez défini au cours de ce processus. Le code suivant permet d'effectuer ce qui suit :
La création d'un autre champ personnalisé avec le même identifiant écrasera le champ personnalisé d'origine. Notez également que chaque champ personnalisé que vous créez l'est pour l'ensemble du compte.
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);
La withDefaultValue() est la valeur qui apparaît après que votre signataire ait signé le document. Cette méthode est requise lors de la création d'un champ personnalisé.
Les champs personnalisés contiennent également une collection de traductions qui sont utilisées lors de l'affichage du champ personnalisé aux membres du compte.
Cette astuce concerne les comptes qui prennent en charge plusieurs langues. En tant que meilleure pratique, chaque champ personnalisé dont vous avez besoin doit être répliqué pour chaque langue prise en charge par votre compte. Le système n'affichera le champ personnalisé que dans la langue sélectionnée par l'utilisateur actif. Si un champ personnalisé n'est pas associé à une langue, celle-ci sera par défaut en anglais, quelle que soit la langue sélectionnée par l'utilisateur actif.
Au moins une traduction est requise lors de la construction de votre objet CustomField . Utilisez le OneSpan Sign CustomFieldService pour créer votre champ personnalisé.
Récupération des champs personnalisés
Vous pouvez récupérer vos champs personnalisés à l'aide de la fonctionOneSpan Sign CustomFieldService. Vous pouvez soit récupérer tous les champs personnalisés, qui vous sont renvoyés sous forme de liste, soit récupérer un champ spécifique en utilisant l'identifiant du champ personnalisé. Le code suivant permet d'effectuer ce qui suit :
// 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);
Suppression d'un champ personnalisé
La suppression d'un champ personnalisé de votre compte se fait également à l'aide de la fonction OneSpan Sign CustomFieldService. Le code suivant permet d'effectuer ce qui suit :
// Delete the second custom field from account eslClient.GetCustomFieldService().DeleteCustomField(customFieldId1);
Modification d'un bloc de signature pour ajouter des champs personnalisés
Pour modifier le bloc de signature afin d'ajouter des codes personnalisés, utilisez le code suivant. Dans cet exemple, des ancres de texte sont utilisées pour positionner les champs de signature et les champs personnalisés. Pour obtenir plus d'informations, consultez Ancres de texte.
.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))))
Résultats
Une fois que vous aurez exécuté votre code, vous constaterez que vos champs personnalisés sont visibles dans votre compte OneSpan Sign. Ces champs personnalisés seront également disponibles pour être utilisés dans les transactions. Pour obtenir plus d'informations, consultez Champs personnalisés.
Pour télécharger l'exemple complet de code, consultez notre site Partage de code.
Un champ personnalisé Un champ qui, au moment de la signature, est automatiquement alimenté avec des données spécifiques au signataire. est un champ qui, au moment de la signature, est automatiquement rempli de données spécifiques au signataire. Par exemple, un signataire peut avoir un numéro d'agent, et ce numéro peut devoir apparaître dans le document final à côté de sa signature. En utilisant un champ personnalisé, le signataire peut spécifier son numéro d'agent, et ce numéro apparaîtra automatiquement dans tout autre champ qui a été configuré pour le recevoir.
La page Champs personnalisés vous permet de gérer les champs personnalisés de votre compte.
Cette fonctionnalité n'est disponible que si les champs personnalisés sont activés au niveau du compte. Veuillez communiquer avec notre équipe de soutien pour les faire activer.
Création d'un champ personnalisé
Chaque champ personnalisé que vous créez est identifié par l'identifiant unique que vous avez défini au cours de ce processus. Dans le JSON ci-dessous, l'objet valeur est la valeur qui apparaît après que votre signataire ait signé le document. Ce champ est obligatoire lors de la création d'un champ personnalisé.
La création d'un autre champ personnalisé avec le même identifiant écrasera le champ personnalisé d'origine. Notez également que chaque champ personnalisé que vous créez l'est pour l'ensemble du compte.
Pour créer un champ personnalisé, vous devez effectuer la demande suivante :
Requête HTTP
POST /api/account/customfields
En-têtes HTTP
Accept: application/json Content-Type: application/json Authorization: Basic api_key
Données utiles de la demande
{ "id":"policy_number_id", "value":"123-456-789-0", "required":false, "translations":[ { "language":"en", "name":"Policy Number", "description":"Car Insurance Policy Number." } ] } Pour une description complète de chaque champ, voir le tableau des données utiles de la demande ci-dessous. Données utiles de la réponse
{ "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": "" } Les champs personnalisés contiennent également une collection de traductions qui sont utilisées lors de l'affichage du champ personnalisé aux membres du compte.
Cette astuce concerne les comptes qui prennent en charge plusieurs langues. En tant que meilleure pratique, chaque champ personnalisé dont vous avez besoin doit être répliqué pour chaque langue prise en charge par votre compte. Le système n'affichera le champ personnalisé que dans la langue sélectionnée par l'utilisateur actif. Si un champ personnalisé n'est pas associé à une langue, celle-ci sera par défaut en anglais, quelle que soit la langue sélectionnée par l'utilisateur actif.
Récupération des champs personnalisés
Vous pouvez soit récupérer tous vos champs personnalisés en faisant une requête GET auprès de :
https://sandbox.esignlive.com/api/account/customfields.
Ou bien, vous pouvez récupérer un champ personnalisé spécifique en utilisant son ID personnalisé dans votre demande GET :
https://sandbox.esignlive.com/api/account/customfields/{customFieldId}
Suppression d'un champ personnalisé
Pour supprimer un champ personnalisé de votre compte, il suffit d'envoyer une demande SUPPRIMER à l'adresse suivante :
https://sandbox.esignlive.com/api/account/customfields/{customFieldId}
Modification d'un bloc de signature pour ajouter des champs personnalisés
Pour modifier le bloc de signature afin d'ajouter des codes personnalisés, utilisez le code suivant. Dans cet exemple, des ancres de texte sont utilisées pour positionner les champs de signature et les champs personnalisés. Pour obtenir plus d'informations, consultez Ancres de texte.
{ "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" } Résultats
Une fois que vous aurez exécuté votre code, vous constaterez que vos champs personnalisés sont visibles dans votre compte OneSpan Sign. Ces champs personnalisés seront également disponibles pour être utilisés dans les transactions. Pour obtenir plus d'informations, consultez Champs personnalisés.
Tableau des données utiles de la demande
| Propriété | Type | Modifiable | Requis | Par défaut | Exemples de valeurs |
|---|---|---|---|---|---|
| id | chaîne de caractères | oui | non | s.o. | policy_number_id |
| valeur | chaîne de caractères | oui | non | s.o. | 123-456-789-0 |
| requis | booléen | oui | non | faux | faux / vrai |
| traductions | |||||
| langue | chaîne de caractères | oui | non | en | en / fr / es ... |
| nom | chaîne de caractères | oui | non | s.o. | Numéro de la police |
| description | chaîne de caractères | oui | non | s.o. | Numéro de police d'assurance automobile |