OneSpan Sign Release 11.25: Modifications récentes de l'API SDK

OneSpan Sign version 11.25 a récemment été déployé dans l'environnement de prévisualisation et de bac à sable. Dans cette nouvelle version, nous avons implémenté un mécanisme de renvoi automatique pour les codes SMS expirés, modifié le comportement SDK de sorte que les paquets défectueux d'un appel de création de paquet seront automatiquement supprimés, étendu l'API REST et SDKs pour fournir la possibilité de rechercher une liste de groupes par nom, continuellement mis à jour l'interface utilisateur de l'expéditeur pour être accessible, et a ajouté plusieurs corrections de bogues. Vous pouvez trouver les dates de déploiement de tous nos environnements sur notre page Trust Center.

Dans ce blog, nous passerons en revue les extensions récentes de l'API REST et les changements de comportement dans les conceptions SDK. Avant de continuer, assurez-vous que votre version OneSpan Sign Environment et SDK sont toutes deux plus tard que 11h25, afin que vous puissiez tester ces mises à jour. 

SUPPRIMER LE PACKAGE CRÉÉ ÉCHOUÉ

Il s'agit d'un changement de comportement à la fonction de création de paquetEs.createPackage (DocumentPackage) pour Java et .Net SDK.

Pour mieux comprendre la valeur de cette mise à jour, il est important de comprendre les différences entre "createPackage" et "createPackageOneStep".

Lors de l'utilisation de la fonction "createPackage", le SDK utilisera des appels REST distincts pour d'abord créer un paquet, puis télécharger les documents et leurs métadonnées. Alors que dans "createPackageOneStep" fonction, le SDK va créer un paquet entièrement cuit en un seul coup.

Dans les implémentations précédentes, si vous utilisiez la fonction "createPackage" et que tout document n'a pas été téléchargé, un package partiellement créé serait laissé dans le dossier Drafts. Alors qu'avec la fonction "createPackageOneStep", soit le paquet sera créé avec succès, soit il ne sera pas créé du tout. 

La fonction createPackage va désormais également saisir les exceptions lors du téléchargement des documents et appeler la fonction PackageService.deletePackage (PackageId) par la suite. Aussi un EslException avec le message "Ne pouvait pas créer un nouveau paquet" est jeté, de sorte qu'il est clair pour l'utilisateur ce qui s'est passé. 

RETRIEVE A LIST OF ALL GROUPS BY NAME

Il s'agit d'une extension API facilitant une recherche de groupe. Le paramètre de requête "nom" a été récemment ajouté à l'appel API pour accélérer vos recherches. Ainsi, vous n'avez pas à récupérer tous les groupes disponibles, boucle à travers et filtrer le nom par votre code personnalisé comme avant.

Si vous n'êtes pas familier avec la fonction OneSpan Sign Groups Feature, consultez notre guide ici. 

Méthode REST:

Demande HTTP

GET /api/groupes

En-têtes HTTP

Accepter : application/json
Content-type: application/JSON
Autorisation: api_key de base

Paramètres de requête optionnels

De : Le premier enregistrement qui sera retourné. Utile pour la pagination.
À: Le dernier enregistrement qui sera retourné. Utile pour la pagination.
Nom: Tous les groupes seront filtrés par le nom. Cette recherche est insensible aux cas.
Réal : La direction selon laquelle les données seront triées. Donnez la valeur asc pour l'ascension, les ordes pour la descente.

Java SDK:

Liste getAllGroups - eslClient.getGroupService().getMyGroups(); //get all groups
Liste getGroupsByName - eslClient.getGroupService().getMyGroups("test_"); //get group by name

.Net SDK:

Liste getAllGroups - eslClient.GroupService.GetMyGroups();		obtenir tous les groupes
Liste getGroupsByName - eslClient.GroupService.GetMyGroups ("test_");		obtenir le groupe par nom

Faisons un test rapide dans Web Portal et Postman. Nous avons créé des groupes de test dans notre tableau de bord.

Maintenant, nous pouvons effectuer des tests D'API via Postman. (Lire ce blog développeur pour apprendre à utiliser Postman)

Comme le montrent les résultats ci-dessus, l'API a retourné avec succès des groupes complets et partiels, y compris les cas dans lesquels des caractères spéciaux sont utilisés.

SUPPRIMER PLUSIEURS DOCUMENTS EN UN SEUL APPEL

Si un signataire refuse ou se retire de la transaction pendant la cérémonie de signature, le propriétaire du paquet devra généralement supprimer plusieurs documents afin de télécharger et de renvoyer le paquet. Cette API nouvellement exposée a été conçue pour vous aider à supprimer une liste de documents sans passer d'appels API répétitifs.

Voyons d'abord la référence API :

Voyons d'abord la référence API :
Demande HTTP
DELETE /api/packages/packageId/documents
En-têtes HTTP
Content-type: application/JSON
Autorisation: api_key de base
Demande de charge utile
["document1ID","document2ID"]

Note:
Cette API ne s'applique qu'aux transactions DRAFT.
L'organisme de demande doit être un tableau JSON avec des pièces d'identité de documents.
Au moins un document id doit être transmis et tous les Ids de document doivent être existants, exacts et non-duplicate, sinon une erreur sera retournée

La fonction SDK correspondante est implémentée comme ci-dessous :

Java SDK

eslClient.getPackageService().deleteDocuments(PackageId packageId, DocumentId... documentides);

.Net SDK (en)

eslClient.PackageService.DeleteDocuments (PackageId packageId, params string[] documentIds);

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!

OneSpan Sign Developer Community

Rejoignez la communauté OneSpan Sign Developer! Forums, blogs, documentation, téléchargements SDK, et plus encore.

Joignez-vous aujourd'hui