Gestion des transactions

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

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 devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign . Pour ce faire, le code suivant :

// Create a PackageId instance using the specified ID
PackageId packageId = new PackageId("package_id_here");

// Retrieve the document package using the ESL client
DocumentPackage retrievedPkg = eslClient.getPackage(packageId);

Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant :

// Retrieve a page of document packages with status SENT
Page<DocumentPackage> resultPage = eslClient
    .getPackageService()
    .getPackages(
        new PackageStatusConverter(PackageStatus.SENT).toAPIPackageStatus(),
        new PageRequest(1, 10)
    );

L'exemple de code ci-dessus renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ.

Limites de notification SMS

Pour éviter toute utilisation abusive et l'envoi excessif de notifications SMS, il y a une limite de 50 notifications SMS par transaction. Une fois la limite de 50 notifications SMS atteinte pour une transaction particulière, un message s'affichera dans l'interface utilisateur et le client ne pourra plus envoyer de SMS pour cette transaction.

Pour les intégrateurs Java et .NET, une alerte indiquant que la limite de notification SMS est atteinte peut être obtenue lors de la récupération d'un paquet. Pour ce faire, le code suivant :

// Retrieve the document package with alerts extension
DocumentPackage packageWithAlerts = eslClient.getPackageWithExtensions(
    packageId,
    DocumentPackageRequestExtension.ALERTS
);

// Extract the list of system alerts from the package
List<SystemAlert> alerts = packageWithAlerts.getAlerts();
``

Mise à jour d'une transaction

Pour mettre à jour une transaction, celle-ci doit avoir le statut BROUILLON.

Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction UpdatePackage avec le PackageId de la transaction existante. Pour ce faire, le code suivant :

// Build a new document package with updated properties
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();
// Update the package using the ESL client
eslClient.updatePackage(packageId, packageToUpdate);

Suppression de transactions

Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage à l'aide du PackageId de la transaction que vous souhaitez supprimer.

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

Pour ce faire, le code suivant :

// Delete the document package using its package ID
eslClient.getPackageService().deletePackage(packageId);
``

Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant :

// Move the document package to the trash using its package ID
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 n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception.

Pour ce faire, appelez le client OneSpan Sign avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant :

// Archive the document package using its package ID
eslClient.getPackageService().archive(new PackageId("packageId"));

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

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 devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign. Pour ce faire, le code suivant :

// Create a PackageId instance using the specified ID
PackageId packageId = new PackageId("package_id_here");

// Retrieve the document package using the ESL client
DocumentPackage retrievedPkg = eslClient.GetPackage(packageId);

Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant :

// Retrieve a page of document packages with status SENT
Page<DocumentPackage> packages = eslClient.PackageService.GetPackages(
    DocumentPackageStatus.SENT,
    new PageRequest(1, 10)
);

L'exemple de code ci-dessus renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ.

Limites de notification SMS

Pour éviter toute utilisation abusive et l'envoi excessif de notifications SMS, il y a une limite de 50 notifications SMS par transaction. Une fois la limite de 50 notifications SMS atteinte pour une transaction particulière, un message s'affichera dans l'interface utilisateur et le client ne pourra plus envoyer de SMS pour cette transaction.

Pour les intégrateurs Java et .NET, une alerte indiquant que la limite de notification SMS est atteinte peut être obtenue lors de la récupération d'un paquet. Pour ce faire, le code suivant :

// Retrieve the document package with the specified extensions
DocumentPackage packageWithAlerts = ossClient.GetPackageWithExtensions(id, extensions);

// Access the list of system alerts from the package
IList<SystemAlert> alerts = packageWithAlerts.Alerts;
``

Mise à jour d'une transaction

Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction UpdatePackage avec le PackageId de la transaction existante. Pour ce faire, le code suivant :

// Build a new document package with updated properties
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();

// Update the package using the ESL client
eslClient.UpdatePackage(packageId, packageToUpdate);

Suppression de transactions

Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage à l'aide du PackageId de la transaction que vous souhaitez supprimer.

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

Pour ce faire, le code suivant :

// Delete the document package using its package ID
eslClient.PackageService.DeletePackage(packageId);

Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant :

// Move the document package to the trash using its package ID
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 n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception.

Pour ce faire, appelez le client OneSpan Sign avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant :

// Archive the document package using its package ID
eslClient.PackageService.Archive(new PackageId("packageId"));

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

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 devez d'abord créer un objet PackageId à l'aide de l'ID qui vous a été renvoyé lors de la création de la transaction. Ensuite, récupérez la transaction à l'aide de ce PackageId dans le client OneSpan Sign. Pour ce faire, le code suivant :

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

Vous pouvez également récupérer une liste de transactions. Pour ce faire, le code suivant :

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

Vous pouvez passer une carte des paramètres de requête afin d'affiner 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 renverra les dix premières transactions qui ont l'état ENVOYÉ. Vous pouvez toutefois interroger d'autres statuts, tels que BROUILLON, TERMINÉ, REFUSÉ, EXPIRÉ et ARCHIVÉ.

Mise à jour d'une transaction

Pour mettre à jour une transaction existante, créez un objet de transaction avec uniquement les mises à jour que vous souhaitez apporter à la transaction. Ensuite, appelez la fonction updatePackage() avec le PackageId de la transaction existante et l'objet Package_x mises à jour. Pour ce faire, le code suivant :

// Option 1: Retrieve and update an existing package
ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);

// Option 2: Create a new package object and update its name
ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();
pkg.name = 'changed package name';

// Update the package using the SDK
sdk.updatePackage(pkg, packageId);

Suppression de transactions

Si vous souhaitez supprimer définitivement une transaction de votre compte, appelez la fonction deletePackage() à l'aide du PackageId de la transaction que vous souhaitez supprimer.

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

Pour ce faire, le code suivant :

// Delete the document package using its package ID
sdk.deletePackage(packageId);

Si vous ne souhaitez pas supprimer définitivement cette transaction, vous pouvez la déplacer vers votre dossier Corbeille . De cette façon, il ne sera pas supprimé et pourra être récupéré à une date ultérieure. Pour ce faire, le code suivant :

// Retrieve the package using its ID
ESignLiveAPIObjects.Package_x pkg = sdk.getPackage(packageId);

// Mark the package as trashed
pkg.trashed = true;

// Update the package to apply the change
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 n'est disponible que pour les transactions TERMINÉES dans votre boîte de réception.

Pour ce faire, appelez la fonction setStatus() avec le PackageId de la transaction que vous souhaitez archiver. Pour ce faire, le code suivant :

// Archive the document package (only possible if the package is completed)
sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.ARCHIVED);

// Restore the archived package by setting its status back to COMPLETED
sdk.setStatus(packageId, ESignLiveAPIObjects.PackageStatus.COMPLETED);