Java SDK .NET SDK REST API APEX SDK
Java SDK
Pour télécharger l’exemple complet de code, consultez notre site de partage de code .
Un placeholder de signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un placeholder peut être attribué à un champ de signature comme si vous assigniez un signataire régulier. Cependant, tous les placeholders doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Comme un placeholder de signature n’a pas d’adresse e-mail, il est identifié par un ID.
Vous pouvez attribuer une méthode d’authentification à un substitut. La méthode s’applique partout où le substitut est utilisé, donc chaque transaction construite à partir de celle-ci bénéficie des mêmes vérifications d’identité sans configuration supplémentaire. Les expéditeurs peuvent toujours passer outre la méthode pour un destinataire spécifique lorsque cela est nécessaire. L’authentification par placeholder peut être configurée depuis l’interface web, l’API et les SDK. REMARQUE : Pour utiliser les SDK, vous devez passer à la dernière version disponible . Pour activer cette fonctionnalité, contactez notre Support Team.
Envoi en masse : Un nouveau paramètre au niveau des transactions, Imposer l’authentification en envoiement massif, contrôle la manière dont l’authentification provisoire s’applique lors de l’envoi en masse. Pour l’activer, contactez notre Support Team.
Non appliqué (par défaut) : Les détails d’authentification dans le CSV Envoie en masse ont la priorité sur la méthode définie sur le placeholder.
Appliqué : La méthode d’authentification dans le CSV doit correspondre à celle définie sur le Placeholder. Si elle ne correspond pas, une erreur apparaît lors du téléchargement du CSV, et vous devez corriger le fichier avant de pouvoir continuer. Les détails d’authentification dans le CSV, tels que les numéros de téléphone ou les valeurs de questions-réponses, sont toujours utilisés.
Limitations : La vérification d’identité n’est pas prise en charge comme méthode d’authentification provisoire. Fast Track ignore l’authentification temporaire. Lorsqu’un modèle est utilisé via Fast Track, l’authentification des destinataires temporaires est réinitialisée à Aucun.
Ajouter un Marque-Remplaçant de Signature à un Modèle
Pour ajouter un Placeholder signature à un modèle, vous devez d’abord créer l’objet Placeholder . Le code suivant créera un objet Placeholder :
Placeholder placeholder = new Placeholder("Manager");Une fois l’objet Placeholder créé, utilisez le OneSpan Sign Template Service pour ajouter votre Placeholder de signature à votre modèle et passer le TemplateId et le Placeholder comme paramètres. Le code suivant fera cela :
Placeholder addedPlaceholder = eslClient.getTemplateService().addPlaceholder(templateId, placeholder); Mise à jour d’un Marque-Place de Signature
Pour mettre à jour un marqueur de signature existant, utilisez le code suivant :
addedPlaceholder.setName("Client");
Placeholder updatedPlaceholder = eslClient.getTemplateService().updatePlaceholder(templateId, addedPlaceholder);Suppression d’un Marque-Signature
Enfin, la suppression d’un marque-place de signature se fait avec le PackageService. Vous devrez passer l’objet TemplateId et la chaîne Placeholder id String comme paramètres.
eslClient.getPackageService().removeSigner(templateId, addedPlaceholder.getId());.NET SDK
Pour télécharger l’exemple complet de code, consultez notre site de partage de code .
Un placeholder de signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un placeholder peut être attribué à un champ de signature comme si vous assigniez un signataire régulier. Cependant, tous les placeholders doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Comme un placeholder de signature n’a pas d’adresse e-mail, il est identifié par un ID.
Vous pouvez attribuer une méthode d’authentification à un substitut. La méthode s’applique partout où le substitut est utilisé, donc chaque transaction construite à partir de celle-ci bénéficie des mêmes vérifications d’identité sans configuration supplémentaire. Les expéditeurs peuvent toujours passer outre la méthode pour un destinataire spécifique lorsque cela est nécessaire. L’authentification par placeholder peut être configurée depuis l’interface web, l’API et les SDK. REMARQUE : Pour utiliser les SDK, vous devez passer à la dernière version disponible . Pour activer cette fonctionnalité, contactez notre Support Team.
Envoi en masse : Un nouveau paramètre au niveau des transactions, Imposer l’authentification en envoiement massif, contrôle la manière dont l’authentification provisoire s’applique lors de l’envoi en masse. Pour l’activer, contactez notre Support Team.
Non appliqué (par défaut) : Les détails d’authentification dans le CSV Envoie en masse ont la priorité sur la méthode définie sur le placeholder.
Appliqué : La méthode d’authentification dans le CSV doit correspondre à celle définie sur le Placeholder. Si elle ne correspond pas, une erreur apparaît lors du téléchargement du CSV, et vous devez corriger le fichier avant de pouvoir continuer. Les détails d’authentification dans le CSV, tels que les numéros de téléphone ou les valeurs de questions-réponses, sont toujours utilisés.
Limitations : La vérification d’identité n’est pas prise en charge comme méthode d’authentification provisoire. Fast Track ignore l’authentification temporaire. Lorsqu’un modèle est utilisé via Fast Track, l’authentification des destinataires temporaires est réinitialisée à Aucun.
Ajouter un Marque-Remplaçant de Signature à un Modèle
Pour ajouter un Placeholder signature à un modèle, vous devez d’abord créer l’objet Placeholder . Le code suivant créera un objet Placeholder :
Placeholder placeholder = new Placeholder("Manager"); Une fois l’objet Placeholder créé, utilisez le OneSpan Sign Template Service pour ajouter votre Placeholder de signature à votre modèle et passer le TemplateId et le Placeholder comme paramètres. Le code suivant fera cela :
Placeholder addedPlaceholder = eslClient.TemplateService.AddPlaceholder(templateId, placeholder); Mise à jour d’un Marque-Place de Signature
Pour mettre à jour un marqueur de signature existant, utilisez le code suivant :
addedPlaceholder.Name = "Client";
Placeholder updatedPlaceholder = eslClient.TemplateService.UpdatePlaceholder(templateId, addedPlaceholder);Suppression d’un Marque-Signature
Enfin, la suppression d’un marque-place de signature se fait avec le PackageService. Vous devrez passer l’objet TemplateId et la chaîne Placeholder id String comme paramètres.
eslClient.PackageService.RemoveSigner(templateId, addedPlaceholder.Id);REST API
Pour télécharger l’exemple complet de code, consultez notre site de partage de code .
Un placeholder de signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un placeholder peut être attribué à un champ de signature comme si vous assigniez un signataire régulier. Cependant, tous les placeholders doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Comme un placeholder de signature n’a pas d’adresse e-mail, il est identifié par un ID.
Vous pouvez attribuer une méthode d’authentification à un substitut. La méthode s’applique partout où le substitut est utilisé, donc chaque transaction construite à partir de celle-ci bénéficie des mêmes vérifications d’identité sans configuration supplémentaire. Les expéditeurs peuvent toujours passer outre la méthode pour un destinataire spécifique lorsque cela est nécessaire. L’authentification par placeholder peut être configurée depuis l’interface web, l’API et les SDK. REMARQUE : Pour utiliser les SDK, vous devez passer à la dernière version disponible . Pour activer cette fonctionnalité, contactez notre Support Team.
Envoi en masse : Un nouveau paramètre au niveau des transactions, Imposer l’authentification en envoiement massif, contrôle la manière dont l’authentification provisoire s’applique lors de l’envoi en masse. Pour l’activer, contactez notre Support Team.
Non appliqué (par défaut) : Les détails d’authentification dans le CSV Envoie en masse ont la priorité sur la méthode définie sur le placeholder.
Appliqué : La méthode d’authentification dans le CSV doit correspondre à celle définie sur le Placeholder. Si elle ne correspond pas, une erreur apparaît lors du téléchargement du CSV, et vous devez corriger le fichier avant de pouvoir continuer. Les détails d’authentification dans le CSV, tels que les numéros de téléphone ou les valeurs de questions-réponses, sont toujours utilisés.
Limitations : La vérification d’identité n’est pas prise en charge comme méthode d’authentification provisoire. Fast Track ignore l’authentification temporaire. Lorsqu’un modèle est utilisé via Fast Track, l’authentification des destinataires temporaires est réinitialisée à Aucun.
Ajouter un Espace Réservé à un Modèle
Pour ajouter un lieu de remplacement de signature à un modèle, utilisez le code suivant :
Requête HTTP
POST /api/packages/{templateId}/rolesEn-têtes HTTP
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key Charge utile de demande
{ "id": "Manager", "type": "SIGNER", "index": 0, "name": "Manager" } Pour une description complète de chaque champ, voir le tableau des charges utiles de demande ci-dessous.
Charge utile de réponse
{
"id": "Manager",
"type": "SIGNER",
"index": 0,
"name": "Manager"
}Mise à jour d’un Marque-Place de Signature
La mise à jour d’un Placeholder se fait également de manière similaire. Vous devrez construire le JSON avec les mises à jour que vous souhaitez effectuer :
Requête HTTP
PUT /api/packages/{templateId}/roles/[roleId}En-têtes HTTP
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key Charge utile de demande
{
"id": "Manager",
"type": "SIGNER",
"index": 0,
"name": "Manager"
}Charge utile de réponse
{
"id": "Manager",
"data": null,
"emailMessage": null,
"attachmentRequirements": [],
"locked": false,
"reassign": false,
"specialTypes": [],
"type": "SIGNER",
"index": 0,
"signers": [],
"name": "Manager"
}Suppression d’un Marque-Signature
Enfin, pour supprimer un placeholder :
Requête HTTP
DELETE /api/packages/{templateId}/roles/{roleId}En-têtes HTTP
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key Table des charges utiles de requêtes
Propriété | Type | Modifiable | Obligatoire | Par défaut | Valeurs d’échantillonnage |
|---|---|---|---|---|---|
Nom | Corde | Oui | Non | N/D | Entraîneur |
id | Corde | Oui | Non | N/D | Entraîneur |
Type | Pignonnier | Oui | Non | SIGNATAIRE | SIGNATAIRE / EXPÉDITEUR |
Nom | Corde | Oui | Non | N/D | Entraîneur |
APEX SDK
Pour télécharger l’exemple complet de code, consultez notre site de partage de code .
Un placeholder de signature est utile si l’identité d’un signataire sera déterminée ultérieurement. Par exemple, lors de la création d’un modèle. Un placeholder peut être attribué à un champ de signature comme si vous assigniez un signataire régulier. Cependant, tous les placeholders doivent être remplacés par de vrais signataires avant que la transaction ne soit distribuée pour la signature. Comme un placeholder de signature n’a pas d’adresse e-mail, il est identifié par un ID.
Vous pouvez attribuer une méthode d’authentification à un substitut. La méthode s’applique partout où le substitut est utilisé, donc chaque transaction construite à partir de celle-ci bénéficie des mêmes vérifications d’identité sans configuration supplémentaire. Les expéditeurs peuvent toujours passer outre la méthode pour un destinataire spécifique lorsque cela est nécessaire. L’authentification par placeholder peut être configurée depuis l’interface web, l’API et les SDK. REMARQUE : Pour utiliser les SDK, vous devez passer à la dernière version disponible . Pour activer cette fonctionnalité, contactez notre Support Team.
Envoi en masse : Un nouveau paramètre au niveau des transactions, Imposer l’authentification en envoiement massif, contrôle la manière dont l’authentification provisoire s’applique lors de l’envoi en masse. Pour l’activer, contactez notre Support Team.
Non appliqué (par défaut) : Les détails d’authentification dans le CSV Envoie en masse ont la priorité sur la méthode définie sur le placeholder.
Appliqué : La méthode d’authentification dans le CSV doit correspondre à celle définie sur le Placeholder. Si elle ne correspond pas, une erreur apparaît lors du téléchargement du CSV, et vous devez corriger le fichier avant de pouvoir continuer. Les détails d’authentification dans le CSV, tels que les numéros de téléphone ou les valeurs de questions-réponses, sont toujours utilisés.
Limitations : La vérification d’identité n’est pas prise en charge comme méthode d’authentification provisoire. Fast Track ignore l’authentification temporaire. Lorsqu’un modèle est utilisé via Fast Track, l’authentification des destinataires temporaires est réinitialisée à Aucun.
Ajouter un Marque-Remplaçant de Signature à un Modèle
Pour ajouter un espace réservé dans un modèle, vous devrez d’abord créer votre objet Rôle . Le code suivant fera ceci :
String placeholderId = 'placeholder1';
ESignLiveAPIObjects.Role placeholder1 = new ESignLiveAPIObjects.Role();
placeholder1.id = placeholderId;
placeholder1.name = placeholderId;Une fois que vous avez construit votre objet Placeholder , utilisez le sdk.helper pour ajouter votre place de signature à votre modèle et passer le TemplateId et le placeholder comme paramètres. Le code suivant fera cela :
sdk.helper.createRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=', placeholder1);Mise à jour d’un Marque-Place de Signature
Pour mettre à jour un marqueur de signature existant, utilisez le code suivant :
sdk.helper.updateRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=','Manager', placeholder1); Suppression d’un Marque-Signature
Enfin, supprimer un marque-repère de signature se fait aussi avec le fichier sdk.helper. Vous devrez passer l’objet TemplateId et la chaîne Placeholder id String comme paramètres.
sdk.helper.deleteRole('E-_tmDsICwCkM2vqFuzVxF7NVQQ=','Manager');