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));

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 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)
    .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); 

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.PackageService.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.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": "signer1@example.com",
			"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.

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. Pour ce faire, faites une demande PUT avec les données utiles suivantes :

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

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 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

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) {
    // Your implementation here
}

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'}); 

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 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);  

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 :

// Trash package
ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);
pkg.trashed = true;
sdk.updatePackage(pkg, 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 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

// Set package to completed before archiving
sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED);

// Restore archive