Ajout, mise à jour et suppression de signataires

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'une des opérations les plus fondamentales et les plus basiques de OneSpan Sign est celle qui consiste à inviter des signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d'une transaction.

Ajout de signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d'abord créer l'objet Signer. Le code suivant va créer un objet Signer :

Signer signer = SignerBuilder.newSignerWithEmail("signer@example.com")
    .withFirstName("John")
    .withLastName("Smith")
    .withCustomId("Signer1")
    .build();

Pour plus d'informations sur la mise à jour des méthodes d'authentification utilisées pour les transactions, voir Authentification des signataires.

Une fois que l'objet Signer a été créé, retrouvez l'objet PackageId qui vous a été renvoyé lors de la création de la transaction et utilisez le client OneSpan Sign pour ajouter votre signataire. Le code suivant permet d'effectuer ce qui suit :

 String signerId = eslClient.getPackageService().addSigner(packageId, signer); 

Mise à jour d'un signataire existant

De même, pour mettre à jour un signataire existant, vous devez créer un objet Signer qui contient les mises à jour que vous souhaitez apporter à votre signataire. Le code suivant permet d'effectuer ce qui suit :

Signer updatedSigner = SignerBuilder.newSignerWithEmail("mary.doe@example.com")
    .withFirstName("Mary")
    .withLastName("Doe")
    .withCustomId("Signer1")
    .build();

Une fois que vous aurez mis à jour le signataire, trouvez l'PackageId (la transaction) pour lequel vous souhaitez changer ce signataire, et utilisez le client OneSpan Sign pour mettre à jour le signataire.

 eslClient.getPackageService().updateSigner(packageId, updatedSigner); 

Suppression des signataires d'une transaction

Pour retirer un signataire d'une transaction, il suffit d'appeler la fonction removeSigner avec la chaîne packageId et signerId.

 eslClient.getPackageService().removeSigner(packageId, signerId); 

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre paquet, vous verrez votre signataire dans votre transaction.

.NET SDK

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'une des opérations les plus fondamentales et les plus basiques de OneSpan Sign est celle qui consiste à inviter des signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d'une transaction.

Ajout de signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d'abord créer l'objet Signer. Le code suivant va créer un objet Signer :

Signer signer = SignerBuilder.NewSignerWithEmail("signer@example.com")
    .WithFirstName("John")
    .WithLastName("Smith")
    .WithCustomId("Signer1")
    .Build();

Une fois que vous aurez mis à jour le signataire, trouvez l'PackageId (la transaction) pour lequel vous souhaitez changer ce signataire, et utilisez le client OneSpan Sign pour mettre à jour le signataire.

 String signerId = eslClient.PackageService.AddSigner(packageId, signer); 

Pour plus d'informations sur la mise à jour des méthodes d'authentification utilisées pour les transactions, voir Authentification des signataires.

Mise à jour d'un signataire existant

De même, pour mettre à jour un signataire existant, vous devez créer un objet Signer qui contient les mises à jour que vous souhaitez apporter à votre signataire. Le code suivant permet d'effectuer ce qui suit :

Signer updatedSigner = SignerBuilder.NewSignerWithEmail("mary.doe@example.com")
    .WithFirstName("Mary")
    .WithLastName("Doe")
    .WithCustomId("Signer1")
    .Build();

Une fois que vous aurez mis à jour le signataire, trouvez l'PackageId (la transaction) pour lequel vous souhaitez changer ce signataire, et utilisez le client OneSpan Sign pour mettre à jour le signataire.

 eslClient.PackageService.UpdateSigner(packageId, updatedSigner); 

Suppression des signataires d'une transaction

Pour retirer un signataire d'une transaction, il suffit d'appeler la fonction removeSigner avec la chaîne packageId et signerId.

 eslClient.PackageService.RemoveSigner(packageId, signerId); 

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre paquet, vous verrez votre signataire dans votre transaction.

API REST

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'une des opérations les plus fondamentales et les plus basiques de OneSpan Sign est celle qui consiste à inviter des signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d'une transaction.

Ajout de signataires à une transaction

Pour ajouter un signataire à une transaction existante, utilisez le code suivant :

Requête HTTP

POST /api/packages/{packageId}/roles

Pour plus d'informations sur la mise à jour des méthodes d'authentification utilisées pour les transactions, voir Authentification des signataires.

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key 

Données utiles de la demande

{
  "id": "Signer5",
  "type": "SIGNER",
  "signers": [
    {
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5"
    }
  ],
  "name": "Signer5"
}

 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

 {
  "id": "Signer5",
  "data": null,
  "specialTypes": [

  ],
  "emailMessage": null,
  "attachmentRequirements": [

  ],
  "locked": false,
  "reassign": false,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": false,
        "email": false,
        "download": false
      },
      "auth": {
        "scheme": "NONE",
        "challenges": [

        ]
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [

      ],
      "userCustomFields": [

      ],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": [

      ]
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Mise à jour d'un signataire existant

Pour mettre à jour un signataire (rôle) existant, créez d'abord une charge utile avec les mises à jour que vous souhaitez effectuer, puis utilisez les exemples de demande ci-dessous pour effectuer vos mises à jour. Utilisez le roleid que vous avez attribué lors de la demande précédente.

Si vous n'avez pas attribué un roleid un identifiant généré aléatoirement sera attribué par OneSpan Sign.

Requête HTTP

PUT /api/packages/{packageId}/roles/{roleId}

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key 

Données utiles de la demande

 {
  "type": "SIGNER",
  "signers": [
    {
      "email": "mary.doe@example.com",
      "firstName": "Mary",
      "lastName": "Doe"
    }
  ]
}

Données utiles de la réponse

{
  "id": "Signer5",
  "data": null,
  "specialTypes": [

  ],
  "emailMessage": null,
  "attachmentRequirements": [

  ],
  "locked": false,
  "reassign": false,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": false,
        "email": false,
        "download": false
      },
      "auth": {
        "scheme": "NONE",
        "challenges": [

        ]
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mary.doe@example.com",
      "firstName": "Mary",
      "lastName": "Doe",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [

      ],
      "userCustomFields": [

      ],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": [

      ]
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Pour une description complète de chaque champ, voir le tableau des données utiles de la demande ci-dessous.

Suppression des signataires d'une transaction

Pour retirer un signataire, vous faites une demande DELETE à l'URI suivant :

Requête HTTP

DELETE /api/packages/{packageId}/roles/{signerId}

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key 

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre paquet, vous verrez votre signataire dans votre transaction.

Tableau des données utiles de la demande

APEX SDK

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'une des opérations les plus fondamentales et les plus basiques de OneSpan Sign est celle qui consiste à inviter des signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d'une transaction.

Ajout de signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d'abord créer l'objet Signer . Le code suivant va créer un objet Signer :

ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();
role.id = 'signer1';
role.signers = sdk.createRolesSigner('John', 'Smith', 'signer@example.com', 'CEO', 'ABC Bank');
sdk.helper.createRole(packageId, role);

Une fois l'objet Signataire créé, retrouvez le PackageId qui vous a été retourné lors de la création de la transaction et utilisez le client OneSpan Sign pour ajouter votre signataire. Le code suivant permet d'effectuer ce qui suit :

  ESignLiveAPIObjects.Role retrievedRole = sdk.getRole(packageId, 'signer1'); 

Pour plus d'informations sur la mise à jour des méthodes d'authentification utilisées pour les transactions, voir Authentification des signataires.

Mise à jour d'un signataire existant

Pour mettre à jour un signataire existant, il suffit de modifier l'un de ses attributs Signer , en récupérant ce signataire. Tous les attributs, à l'exception de l'attribut RoleID le code suivant permet de le faire :

retrievedRole.signers.get(0).firstName = 'changed firstname';
retrievedRole.signers.get(0).lastName = 'changed lastname';
retrievedRole.signers.get(0).email = 'changed@example.com';

Ensuite, trouvez le PackageId dans lequel vous souhaitez changer ce signataire et utilisez le sdk OneSpan Sign pour mettre à jour le signataire.

 sdk.updateRole(packageId,'signer1',retrievedRole); 

Suppression des signataires d'une transaction

Pour retirer un signataire d'une transaction, il suffit d'appeler la fonction deleteRole avec les paramètres packageID et la chaîne roleId .

 sdk.helper.deleteRole(packageId, 'signer1'); 

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et naviguez vers votre paquet, vous verrez votre signataire dans votre transaction.