Blog OneSpan

OneSpan Signe Comment: Créer des champs

Développeurs
Haris Haidary, juillet 20, 2016
Thumbnail

Les champs permettent le placement de données supplémentaires dans un document au moment de la signature. Les champs peuvent être placés n'importe où à l'intérieur d'un document et chaque champ est lié à une signature particulière. Par exemple, vous pouvez ajouter un champ de texte sur un document pour un signataire demandant son adresse. Il est important de noter que seul le signataire de cette signature peut attribuer ou modifier la valeur du champ. Une fois la signature signée, la valeur du champ ne peut plus être modifiée.

Type de champs

Il existe deux types de champs : liés et non liés. Un champ lié est un champ dont la valeur est automatiquement attribuée par OneSpan Sign au moment de la signature (par exemple la date de signature). Un champ non lié, d'autre part, est un champ dont la valeur ne peut être attribuée ou modifiée que par le signataire concerné avant la signature associée est signée. Un champ non lié peut également être réglé pour avoir une valeur par défaut.

Champs liés

Ce qui suit est une liste des champs liés disponibles. Pendant la création du paquet, si ces champs ont été réglés et placés sur le document par l'expéditeur, ils seront automatiquement peuplés une fois que les signatures sont signées par le signataire.

  • Nom du signataire
  • Titre de Signer
  • Nom de l’entreprise
  • Date de signature

Champs non liés

Voici une liste des champs non liés disponibles.

  • Case à cocher
  • Boîte de texte
  • Liste déroulante : permet au signataire de choisir une valeur parmi une liste
  • Bouton Radio : permet au signataire de sélectionner l'une des nombreuses options
  • Zone de texte: similaire à la boîte de texte, mais il fournit enveloppage automatique autour. Il y a une limite de 4000 caractères sur les zones de texte
  • Champ d'étiquettes : un champ de lecture seulement avec une valeur qui sera simplement estampillée sur le PDF
OneSpan Sign Developer Community

OneSpan Sign Developer Community

Rejoignez la communauté OneSpan Sign Developer! Forums, blogs, documentation, téléchargements SDK, et plus encore.

Joignez-vous aujourd'hui

 

Le code

Vous pouvez télécharger le code d'exemple complet à partir du Partage de Code Communautaire Développeur : Java SDK, .NET SDK, et REST API.

Java SDK

Pour ajouter un champ sur un document à l'aide du Java SDK, vous devez d'abord créer votre objet Field à l'aide du OneSpan Sign FieldBuilder, comme indiqué ci-dessous.

Champ de terrain - FieldBuilder.label()
        .withId (nouveau FieldId("myLabelField"))
	.withValue ("Exemple de valeur de champ d'étiquette")
	.atPosition(100, 200)
	.onPage(0)
	.construire();

Une fois que vous avez construit votre objet Field, vous faites appel au service d'approbation de OneSpan Sign pour ajouter votre champ sur votre document et passer les objets PackageId, SignatureId et Field ainsi que le document id String comme paramètres.

Étiquette de chaîneFieldId - client.getApprovalService().addField(packageId, "sample-contract", signatureid, field);

 

SDK .NET

Pour ajouter un champ sur un document à l'aide du SDK .NET, vous devez d'abord créer votre objet Field à l'aide du OneSpan Sign FieldBuilder, comme indiqué ci-dessous.

Champ de terrain - FieldBuilder.Label()
	. WithId ("myLabelField")
	. WithValue ("Exemple de valeur de champ d'étiquette")
	. AtPosition(100, 200)
        . OnPage(0)
	. Build ();

Une fois que vous avez construit votre objet Field, vous faites appel au service d'approbation de OneSpan Sign pour ajouter votre champ sur votre document et passer les objets PackageId, SignatureId et Field ainsi que le document id String comme paramètres.

étiquette de chaîneFieldId - client. ApprovalService.AddField (packageId, "sample-contract", signatureid, field);

 

API REST

L'exemple ci-dessous vous montre comment modifier l'objet « approbations » afin d'ajouter des champs sur votre document avec l'API REST.

{
  "approbations": [
    {
      "id": "ExempleSignatureId",
      "rôle": "Signer1",
      "champs": [
        {
          "page": 0,
          "top": 200,
          "sous-type": "LABEL",
          "hauteur": 50,
          "gauche": 100,
          "largeur": 200,
          "id": "myLabelField",
          "type": "INPUT",
          "valeur": "Exemple de valeur de champ d'étiquette"
        },
        {
          "page": 0,
          "top": 100,
          "sous-type": "FULLNAME",
          "hauteur": 50,
          "gauche": 100,
          "largeur": 200,
          "type": "SIGNATURE",
          "nom": "ExempleSignatureId"
        }
      ],
      "nom": ""
    }
  ],
  "id": "échantillon-contrat",
  "nom": "Test Document"
}

Exécution de votre code

Une fois que vous avez exécuté votre code, si vous vous connectez à OneSpan Sign et que vous vous dirigez vers la vue du document de votre paquet, vous pouvez afficher le champ de date de signature supplémentaire.

 

 

Vous pouvez suivre ce guide pour un tutoriel complet sur la façon d'ajouter, mettre à jour et supprimer un champ à l'aide de l'API Java SDK, .NET Et REST.

Si vous avez des questions concernant ce blog ou toute autre chose concernant l'intégration oneSpan Sign dans votre application, visitez les forums de la communauté des développeurs: https://developer.OneSpan.com. C'est moi qui l'ai fait. Merci de lire! Si vous avez trouvé ce message utile, s'il vous plaît le partager sur Facebook, Twitter, ou LinkedIn.

Haris Haidary
Évangéliste technique junior
LinkedIn - France Twitter (en)

 

Haris Haidary
Haut de page
Partager