Gestion des transactions

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

Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction.

Récupération des transactions

Pour récupérer une transaction, vous devrez d'abord créer un objet PackageId en utilisant l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction en utilisant cette PackageId dans le client OneSpan Sign. Le code suivant permet d'effectuer ce qui suit :

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.getPackage(packageId);

Vous pouvez également récupérer une liste de transactions. Le code suivant permet d'effectuer ce qui suit :

 Page<DocumentPackage> resultPage = eslClient.getPackageService().getPackages( new PackageStatusConverter(PackageStatus.SENT).toAPIPackageStatus(), new PageRequest(1, 10));

L'exemple de code ci-dessus renvoie les dix premières transactions dont le statut est ENVOYÉ. Vous pouvez toutefois demander d'autres statuts, comme ÉBAUCHE, COMPLÉTÉ, DÉCLINÉ, EXPIRÉ et ARCHIVÉ.

Mise à jour d'une transaction

Pour mettre à jour une transaction, celle-ci doit avoir le statut de ÉBAUCHE.

Pour mettre à jour une transaction existante, créez un objet de transaction contenant uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la UpdatePackage avec la valeur PackageId de la transaction existante. Le code suivant permet d'effectuer ce qui suit :

 DocumentPackage packageToUpdate = PackageBuilder.newPackageNamed(NEW_PACKAGE_NAME)   .describedAs(NEW_DESCRIPTION)   .withEmailMessage(NEW_EMAIL_MESSAGE)   .expiresAt(LocalDateTime.now().toDate())   .withLanguage(Locale.FRENCH)   .withVisibility(NEW_VISIBILITY)   .withNotarized(NEW_NOTARIZED)   .autocomplete(false)   .withSettings(settingsToUpdate)   .build();   eslClient.updatePackage(packageId, packageToUpdate);

Suppression de transactions

Si vous voulez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage en utilisant le numéro PackageId de la transaction que vous souhaitez supprimer.

La suppression d'une transaction ne peut être annulée.

Le code suivant permet d'effectuer ce qui suit :

 eslClient.getPackageService().deletePackage(packageId);

Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer dans votre dossier Corbeille. De cette façon, il ne sera pas supprimé et pourra être récupéré ultérieurement. Le code suivant permet d'effectuer ce qui suit :

 eslClient.getPackageService().trash(packageId);

Archivage des transactions

L'action Archiver déplace les transactions sélectionnées de votre boîte de réception vers le dossier Archivé contenant toutes vos transactions archivées. Cette action est disponible uniquement pour les transactions COMPLÉTÉ dans votre boîte de réception.

Pour ce faire, appelez le client OneSpan Sign avec l'PackageId de la transaction que vous souhaitez archiver. Le code suivant permet d'effectuer ce qui suit :

 eslClient.getPackageService().archive(new PackageId("packageId"));

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

Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction.

Récupération des transactions

Pour récupérer une transaction, vous devrez d'abord créer un objet PackageId en utilisant l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction en utilisant cet PackageId dans le client OneSpan Sign. Le code suivant permet d'effectuer ce qui suit :

 PackageId packageId = new PackageId("package_id_here");   DocumentPackage retrievedPkg = eslClient.GetPackage(packageId);

Vous pouvez également récupérer une liste de transactions. Le code suivant permet d'effectuer ce qui suit :

 Page<DocumentPackage> packages = eslClient.PackageService.GetPackages (DocumentPackageStatus.SENT, new PageRequest(1, 10));

Mise à jour d'une transaction

 DocumentPackage packageToUpdate = PackageBuilder.NewPackageNamed(NEW_PACKAGE_NAME)   .WithEmailMessage(NEW_EMAIL_MESSAGE)   .ExpiresOn(NEW_EXPIRY_DATE)   .WithLanguage(NEW_LANGUAGE)   .WithVisibility(NEW_VISIBILITY)   .WithNotarized(NEW_NOTARIZED)   .WithoutAutomaticCompletion()   .WithSettings(settingsToUpdate)   .Build();   eslClient.UpdatePackage(packageId, packageToUpdate);

Suppression de transactions

Si vous voulez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage en utilisant le numéro PackageId de la transaction que vous souhaitez supprimer.

La suppression d'une transaction ne peut être annulée.

Le code suivant permet d'effectuer ce qui suit :

 eslClient.PackageService.DeletePackage(packageId);

 eslClient.PackageService.Trash(packageId);

Archivage des transactions

Pour ce faire, appelez le client OneSpan Sign avec l'PackageId de la transaction que vous souhaitez archiver. Le code suivant permet d'effectuer ce qui suit :

 eslClient.PackageService.Archive(new PackageId("packageId"));

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

Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction.

Récupération des transactions

Pour récupérer un paquet (GET), mettre à jour (PUT), ou supprimer un paquet (DELETE), vous devrez faire votre demande à l'URL suivante en utilisant le nom de domaine PackageId qui vous a été renvoyé lors de la création de la transaction. Le code suivant permet d'effectuer ce qui suit :

 {instance_url}/api/packages/{packageId}

Vous pouvez également récupérer une liste de transactions. Le code suivant permet d'effectuer ce qui suit :

Requête HTTP

GET /api/packages?from=1&to=5&query=SENT

En-têtes HTTP

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

Données utiles de la réponse

 {   "results": [   {...},   {...},   {...},   {...},   {...}   ],   "count": 30   }

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

L'exemple de code ci-dessus renvoie les cinq premières transactions dont le statut est ENVOYÉ, sur un total de 30. Vous pouvez toutefois demander d'autres statuts, comme ÉBAUCHE, COMPLÉTÉ, DÉCLINÉ, EXPIRÉ et ARCHIVÉ.

Mise à jour d'une transaction

Pour mettre à jour un paquet existant qui est en statut ÉBAUCHE, il suffit de créer une charge utile contenant uniquement les mises à jour que vous souhaitez apporter au paquet et de faire votre demande PUT :

Requête HTTP

PUT /api/packages/{packageId}

En-têtes HTTP

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

Données utiles de la demande

{
	"due": "2017-02-13T21:18:40Z",
	"emailMessage": "new email message",
	"notarized": true,
	"settings": { ...
	},
	"description": "",
	"autocomplete": false,
	"visibility": "ACCOUNT",
	"status": "DRAFT",
	"type": "PACKAGE",
	"roles": [{
		"reassign": false,
		"locked": false,
		"index": 0,
		"type": "SENDER",
		"signers": [{
			"title": null,
			"address": null,
			"phone": "",
			"firstName": "Haris",
			"lastName": "Haidary",
			"email": "[email protected]",
			"company": "Onespan",
			"language": "fr",
			"name": ""
		}],
		"name": "Owner"
	}],
	"language": "fr",
	"name": "new package name",
	"bulkSendable": false
}

Suppression de transactions

La suppression d'une transaction ne peut être annulée.

Si vous souhaitez supprimer définitivement une transaction de votre compte, il vous suffit d'effectuer une demande de SUPPRESSION en utilisant l'PackageId de la transaction que vous souhaitez supprimer.

Requête HTTP

PUT /api/packages/{packageId}

En-têtes HTTP

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

Données utiles de la demande

 {   "trashed": true   }

Archivage des transactions

Pour archiver un paquet, il suffit de mettre le statut du paquet à ARCHIVÉ :

Requête HTTP

PUT /api/packages/{packageId}

En-têtes HTTP

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

Données utiles de la demande

 {   "status": "ARCHIVED"   }

Tableau des données utiles de la demande

Propriété	Type	Modifiable	Requis	Par défaut	Exemples de valeurs
statut	chaîne de caractères	Oui	Non	ÉBAUCHE	ÉBAUCHE / ENVOYÉ / COMPLÉTÉ / ARCHIVÉ / DÉCLINÉ / EXPIRÉ
dû	chaîne de caractères	Oui	Oui	nul	2017-02-13T21:18:40Z
MessageCourriel	chaîne de caractères	Oui	Oui	nul	nouveau courriel
notarié	booléen	Oui	Oui	faux	vrai / faux
description	chaîne de caractères	Oui	Oui	nul	Exemple de transaction de STU BANK
ComplétionAuto	booléen	Oui	Non	vrai	vrai / faux
type	chaîne de caractères	Oui	Non	PACKAGE	PAQUET / MODÈLE / MISE EN PAGE
nom	chaîne de caractères	Oui	Oui	s.o.	Exemple d'attributs de document
supprimé	booléen	Oui	Non	faux	vrai / faux
langue	chaîne de caractères	Oui	Oui	en	en / fr / es ...
visibilité	chaîne de caractères	Oui	Non	COMPTE	COMPTE / EXPÉDITEUR
bulkSendable	booléen	Oui	Non	faux	faux / vrai
rôles
id	chaîne de caractères	Oui	Non	s.o.	Client1
index	entier	Oui	Non	0	0 / 1 / 2 ...
attribuer de nouveau	booléen	Oui	Non	faux	faux / vrai
verrouillé	booléen	Oui	Non	faux	faux / vrai
nom	chaîne de caractères	Oui	Non	s.o.	Client1
type	chaîne de caractères	Oui	Non	SIGNER	SIGNATAIRE / EXPÉDITEUR
signataires
courriel	chaîne de caractères	Oui	Oui	s.o.	courriel.pré[email protected]
Prénom	chaîne de caractères	Oui	Oui	s.o.	John
Nom de famille	chaîne de caractères	Oui	Oui	s.o.	Smith
téléphone	chaîne de caractères	Oui	Non	s.o.	514-555-8888
id	chaîne de caractères	Oui	Non	s.o.	Client1
entreprise	chaîne de caractères	Oui	Non	s.o.	Acme Inc.
adresse	chaîne de caractères	Oui	Non	s.o.	123 Main St.
titre	chaîne de caractères	Oui	Non	s.o.	Directeur général
paramètres
cérémonie
en personne	booléen	Oui	Non	faux	faux / vrai
declineButton	booléen	Oui	Non	vrai	faux / vrai
declineReasons	chaîne de caractères	Oui	Non	s.o.	nouvelle raison de déclin #1
optOutReasons	chaîne de caractères	Oui	Non	s.o.	nouvelle raison de refus #1 Remarque : L'option de ne pas participer n'est plus disponible dans l'Signer Experience.
disableDeclineOther	booléen	Oui	Non	faux	faux / vrai
disableDownloadForUncompletedPackage	booléen	Oui	Non	faux	faux / vrai
disableFirstInPersonAffidavit	booléen	Oui	Non	faux	faux / vrai
disableInPersonAffidavit	booléen	Oui	Non	faux	faux / vrai
disableOptOutOther	booléen	Oui	Non	faux	faux / vrai Remarque : L'option de ne pas participer n'est plus disponible dans l'Signer Experience.
disableSecondInPersonAffidavit	booléen	Oui	Non	faux	faux / vrai
hideCaptureText	booléen	Oui	Non	faux	faux / vrai
hideLanguageDropdown	booléen	Oui	Non	faux	faux / vrai
hidePackageOwnerInPerson	booléen	Oui	Non	faux	faux / vrai
hideWatermark	booléen	Oui	Non	faux	faux / vrai
maxAuthFailsAllowed	entier	Oui	Non	3	1 / 2 / 3 ...
optOutButton	booléen	Oui	Non	faux	faux / vrai Remarque : L'option de ne pas participer n'est plus disponible dans l'Signer Experience.
mise en page
iframe	booléen	Oui	Non	faux	faux / vrai
navigateur	booléen	Oui	Non	faux	faux / vrai
en-tête
rétroaction	booléen	Oui	Non	faux	faux / vrai
chemin de navigation	booléen	Oui	Non	faux	faux / vrai
globalNavigation	booléen	Oui	Non	faux	faux / vrai
sessionBar	booléen	Oui	Non	faux	faux / vrai
BarreTitre
progressBar	booléen	Oui	Non	faux	faux / vrai
BarreTitre	booléen	Oui	Non	faux	faux / vrai
globalActions
confirmer	booléen	Oui	Non	faux	faux / vrai
télécharger	booléen	Oui	Non	faux	faux / vrai
hideEvidenceSummary	booléen	Oui	Non	faux	faux / vrai
saveAsLayout	booléen	Oui	Non	faux	faux / vrai
brandingBar
logo
src	chaîne de caractères	Oui	Non	nul	source de l'image du nouveau logo
lien	chaîne de caractères	Oui	Non	nul	lien vers l'image du nouveau logo
événements
complet
dialogue	booléen	Oui	Non	faux	vrai / faux
rediriger	chaîne de caractères	Oui	Non	nul	https://www.google.ca
transfert
href	chaîne de caractères	Oui	Non	nul	http://www.new.ca
titre	chaîne de caractères	Oui	Non	nul	nouvelle infobulle du lien de transfert
texte	chaîne de caractères	Oui	Non	nul	nouveau texte du lien de transfert

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

Cette rubrique décrit comment récupérer, mettre à jour, archiver et supprimer une transaction.

Récupération des transactions

Pour récupérer une transaction, vous devrez d'abord créer un objet PackageId en utilisant l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction en utilisant cet PackageId dans le client OneSpan Sign. Le code suivant permet d'effectuer ce qui suit :

 //retrieve a package   ESignLiveSDK sdk = new ESignLiveSDK();   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);

Vous pouvez également récupérer une liste de transactions. Le code suivant permet d'effectuer ce qui suit :

 public List<ESignLiveAPIObjects.Package_x> getPackages(Map<String,String> queryParameters)

Vous pouvez passer une carte de paramètres de requête afin de restreindre votre recherche comme ceci :

 List<ESignLiveAPIObjects.Package_x> pkgs = getPackages(new Map<String,String>{'from'=>'0','to'=>'9','status'=>'SENT'});

Mise à jour d'une transaction

Pour mettre à jour une transaction existante, créez un objet de transaction contenant uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction updatePackage() avec l'objet PackageId de la transaction existante et l'objet Package_x mis à jour. Le code suivant permet d'effectuer ce qui suit :

 //update package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId); //or   ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();   pkg.name = 'changed package name';   sdk.updatePackage(pkg, packageId);

Suppression de transactions

Si vous voulez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage () en utilisant le numéro PackageId de la transaction que vous souhaitez supprimer.

La suppression d'une transaction ne peut être annulée.

Le code suivant permet d'effectuer ce qui suit :

 //delete package   sdk.deletePackage(packageId);

 //trash package   ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);   pkg.trashed = true;   sdk.updatePackage(pkg, packageId);

Archivage des transactions

Pour ce faire, appelez la fonction setStatus() avec le numéro PackageId de la transaction que vous souhaitez archiver. Le code suivant permet d'effectuer ce qui suit :

 //archive package   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.ARCHIVED);   //you can only archive completed packages   sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED); //restore archive

Récupération des transactions

Mise à jour d'une transaction

Suppression de transactions

Archivage des transactions

Récupération des transactions

Mise à jour d'une transaction

Suppression de transactions

Archivage des transactions

Récupération des transactions

Requête HTTP

En-têtes HTTP

Données utiles de la réponse

Mise à jour d'une transaction

Requête HTTP

En-têtes HTTP

Données utiles de la demande

Suppression de transactions

Requête HTTP

En-têtes HTTP

Données utiles de la demande

Archivage des transactions

Requête HTTP

En-têtes HTTP

Données utiles de la demande

Tableau des données utiles de la demande

Récupération des transactions

Mise à jour d'une transaction

Suppression de transactions

Archivage des transactions

Log in

Two-step verification is required