OneSpan Sign Developer: Archive, Trash and Delete

Dans OneSpan Sign, Archive, Trash et Delete sont toutes des actions de transaction qui vous permettent de gérer le cycle de vie de votre transaction une fois qu'elle est terminée ou n'est plus nécessaire. Si vous souhaitez restreindre l'accès aux transactions terminées ou tout simplement supprimer une transaction, ce blog clarifiera les concepts et le comportement de ces trois actions de transaction, vous aidera à comprendre comment ils sont conçus, et expliquercomment programmer les appliquer.

Archive

Dans OneSpan Sign, il y a les statuts de paquet suivants :

DRAFT / SENT / COMPLETED / ARCHIVÉ / DECLINED / OPTED_OUT / EXPIRED

Notez que seul "ARCHIVED" est un statut de paquet alors que les deux autres sujets "TRASHED" et "DELETED" ne sont pas.

L'action Archive 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 "COMPLETED" dans votre boîte de réception.

L'action Restaurer est utilisée pour modifier les transactions sélectionnées à leur état précédent. Cette action n'est disponible que pour les transactions dans le dossier Archivé ou Trashed. Par exemple, l'action Restaurer modifiera l'état d'un paquet de " ARCHIVÉ " à "COMPLETED".

Dans REST:

Demande HTTP
PUT /api/packages/ 'packageId'

En-têtes HTTP
Autorisation: api_key de base
Accepter : application/json
Content-type: application/JSON

Demande de charge utile
{
  "statut": "ARCHIVED"/"COMPLETED"
}

Dans Java SDK:

eslClient.getPackageService().archive(packageId);		action d'archive
eslClient.getPackageService().markComplete(packageId);	restaurer les archives

Dans .Net SDK:

eslClient.PackageService.Archive(packageId);		action d'archive
eslClient.packageService.MarkComplete(packageId);	restaurer les archives

À Apex SDK

ESignLiveSDK sdk - nouveau ESignLiveSDK();
sdk.setStatus("packageID", eSignLiveAPIObjects.packageStatus.ARCHIVED); action d'archive
sdk.setStatus("packageID", eSignLiveAPIObjects.packageStatus.COMPLETED); restaurer les archives

Une fois qu'un paquet est archivé, votre signataire n'aura pas accès au paquet. Quand ils cliquent sur le lien de téléchargement dans leur e-mail, ils verront "Accès refusé" comme l'image ci-dessous montre.

En tant qu'expéditeur, vous pouvez toujours récupérer des métadonnées, télécharger le résumé des documents/preuves, appeler les fonctions REST/SDK comme vous le pouvez avec n'importe quel autre package "COMPLETED".

Poubelle

L'action Trash est utilisée pour déplacer une transaction sélectionnée de votre boîte de réception/Drafts/Archived Folder au dossier trash.

Comme nous l'avons mentionné ci-dessus, "TRASHED" n'est pas un statut de paquet, alors comment pouvons-nous représenter un paquet comme saccagé? Il ya un attribut distinct nommé "trashed" dans le paquet JSON.

Si cette propriété est réglé sur "vrai", le paquet est "TRASHED", et vous ne pouvez le trouver dans votre trash Folder. Étant donné que le saccage d'un paquet ne change pas son statut, si vous redevenez la propriété à faux, le paquet sera récupéré tout en maintenant le statut approprié.

Dans REST:

Demande HTTP
PUT /api/packages/ 'packageId'

En-têtes HTTP
Autorisation: api_key de base
Accepter : application/json
Content-type: application/JSON

Demande de charge utile
{
  "trashed": vrai/faux
}

Dans Java SDK:

eslClient.getPackageService().trash(packageId);		action trash
eslClient.getPackageService().restore(packageId);	restaurer les ordures

Dans .Net SDK:

eslClient.PackageService.Trash (packageId);		action trash
eslClient.PackageService.Restore(packageId);	restaurer les ordures

Dans Apex SDK:

ESignLiveSDK sdk - nouveau ESignLiveSDK();
Paquet de cordesId '2APPpsAcqVk8QbJKABFqWvHy-kQ'; 
ESignLiveAPIObjects.Package_x pack - sdk.getPackage(packageId);
pack.trashed - vrai;	action trash
pack.trashed - faux;	restaurer les ordures
sdk.updatePackage (pack, packageId);

TRASHing un paquet le mettra dans le dossier TRASH pendant 2 semaines, après quoi il sera supprimé, de façon permanente.

supprimer

Une demande "DELETE" est effectuée en appelant le même api REST que la récupération des métadonnées du paquet. Une fois qu'un paquet est supprimé, seul le packageID est conservé avec un statut de DELETED dans OneSpan Sign. Tout le reste est supprimé et ne peut pas être rétabli.

Dans REST:

Demande HTTP
DELETE /api/packages/ 'packageId'

En-têtes HTTP
Autorisation: api_key de base
Accepter : application/json
Content-type: application/JSON

Dans Java SDK:

eslClient.getPackageService().deletePackage(packageId);		supprimer l'action

Dans .Net SDK:

eslClient.PackageService.DeletePackage(packageId);		supprimer l'action

Dans Apex SDK:

ESignLiveSDK sdk - nouveau ESignLiveSDK();
sdk.deletePackage ('packageId');	supprimer l'action

L'action Supprimer diffère de l'action Trash car il n'y a aucun moyen de restaurer un paquet après qu'il a été supprimé. Lorsque vous essayez d'accéder à la transaction à nouveau, vous verrez toujours ci-dessous l'image, qui vous indique que le paquet n'est plus accessible. Avec Trash Action, vous avez toujours la chance de restaurer votre colis dans les 2 semaines.

Grâce au blog d'aujourd'hui, nous avons passé en revue trois actions de transaction : Archive, Trash et Delete. Vous avez maintenant une compréhension plus claire de la façon dont ils sont conçus et apprendre à les utiliser ou à les restaurer dans les deux méthodes REST et SDK.

Si vous avez des questions concernant ce blog ou toute autre chose concernant l'intégration de OneSpan Sign dans votre application, visitez les Forums communautairesdes développeurs . Vos commentaires sont importants pour nous!