OneSpan Sign Release 11.43 : Améliorations apportées aux SDK
La version 11.43 de OneSpan Sign a récemment été déployée dans l'environnement de prévisualisation. Dans cette dernière version, nous avons introduit plusieurs nouvelles méthodes d'authentification de l'identité d'un destinataire, continué à améliorer l'expérience du nouveau signataire et la nouvelle interface utilisateur de l'expéditeur à bien des égards, amélioré les SDK pour prendre en charge les nouvelles fonctionnalités, et bien d'autres choses encore. Pour une liste complète des mises à jour du produit, consultez la note de mise à jour 11.43. Consultez également notre Trust Center pour connaître les dates de déploiement de tous nos environnements.
Dans ce blog, nous allons explorer un autre notificateur d'événements Javascript nouvellement introduit, puis nous nous concentrerons sur les récentes améliorations apportées aux SDK Java et .NET. Sans plus attendre, commençons !
Nouvel événement notificateur Javascript
Lorsqu'un lien de signature est intégré et présenté dans une iFrame, la cérémonie de signature OneSpan envoie un notificateur d'événement Javascript à votre fenêtre parent pour l'informer du changement d'état. Les notifications d'événements sont déclenchées par des événements particuliers et répondent à différents besoins et cas d'utilisation. Par exemple, lorsqu'un signataire a terminé la transaction, votre fenêtre parent peut écouter l'événement "ESL:MESSAGE:SUCCESS:SIGNER_COMPLETE" et poursuivre le processus de signature en conséquence.
Depuis la version 11.43, une notification Javascript supplémentaire a été introduite pour les transactions en personne ou notariées lorsqu'un signataire a fini de signer sa partie et est prêt à cliquer sur le bouton "Terminé" pour revenir à la page de changement de signataire.
Votre fenêtre parentale peut attendre un message de notification avec l'ID du signataire annexé, voir le tableau ci-dessous :
Nom de l'événement |
Description de l'événement |
L'événement peut-il être temporairement interrompu ? |
ESL:MESSAGE:SUCCESS:SIGNER_DONE : |
Lorsque les signataires ont terminé leur part dans une transaction en personne |
Non |
Notez que ce tableau fait référence à l'identifiant du signataire. Pour les développeurs REST, il pointe vers "roles" > "signers" > "id" dans le JSON de votre paquet. Pour les utilisateurs du SDK, il s'agit soit de l'identifiant personnalisé des signataires, soit de l'identifiant de l'expéditeur pour le propriétaire de la transaction.
Nouvelle notification de rappel pour les SDK
Lesnotifications de rappel, quant à elles, envoient des notifications à votre backend (au lieu du navigateur) lorsqu'un certain événement est déclenché. Dans le blog précédent, nous avons présenté un nouvel événement de rappel, "Document consulté", qui se déclenche lorsqu'un signataire navigue vers un document. Depuis la version 11.43, les développeurs peuvent désormais enregistrer cet événement via les SDK. Consultez les extraits de code ci-dessous :
SDK Java :
final String callback_url = "http://my.url.com" ; final String callback_key = "myCallbackKey" ; eslClient.getEventNotificationService().register(EventNotificationConfigBuilder.newEventNotificationConfig(callback_url).withKey(callback_key) .forEvent(NotificationEvent.DOCUMENT_VIEWED)) ;
.NET SDK :
OssClient ossClient = new OssClient(API_KEY, API_URL) ; ossClient.EventNotificationService.Register(EventNotificationConfigBuilder.NewEventNotificationConfig("https://my.address.com") .WithKey("somekeyhere") .ForEvent(NotificationEvent.DOCUMENT_VIEWED) .build()) ;
Notez que pour tirer parti de cette fonctionnalité, vous devez mettre à jour votre SDK avec la version 11.43 ou une version ultérieure.
Récupérer les clés API des sous-comptes
La fonction de sous-compte permet à une organisation de créer des comptes enfants (ou même petits-enfants) au sein du compte principal de l'organisation sur la base de ses départements, de ses emplacements géographiques ou de ses secteurs d'activité. Un sous-compte peut avoir ses propres marques et paramètres de compte, indépendamment des autres sous-comptes ou du compte principal.
Comme pour les intégrations sur le compte principal, la mise en œuvre des cas d'utilisation sur les sous-comptes dépend de la récupération de la clé API de l'administrateur du sous-compte. Étant donné qu'un signataire peut être associé à plusieurs sous-comptes, si la personne s'est vu attribuer un rôle dans chaque sous-compte, cela génère plusieurs clés API distinctes pour chaque sous-compte, ce qui peut être difficile à récupérer et à gérer.
Pour atténuer ce problème, OneSpan Sign a exposé une API permettant exclusivement de récupérer les clés d'API des sous-comptes d'un signataire lorsque la personne a accès à l'API. Voir ci-dessous :
Requête HTTP
GET /api/account/subaccountApiKeys
En-têtes HTTP
Authorization : Basic api_key / Bearer access_token Accept : application/json
Exemple de réponse :
[ { "accountUid" : "vMAyraE2jrc7", "accountName" : "subaccount1", "apiKey" : "N1R6RxxxxBVw==" }, { "accountUid" : "jBOspAfonpE2", "accountName" : "subaccount2", "apiKey" : "N1R6RxxxxrVw==" } ]
Remarque :
- En tant que clé API d'autorisation, le signataire doit se voir attribuer un rôle dans ce sous-compte particulier avec des autorisations de "Gestion des utilisateurs", de "Gestion des sous-comptes" et d'"Accès API". Il s'agit généralement du rôle "Admin" ou d'un rôle personnalisé avec des autorisations similaires.
- L'API renvoie une liste de sous-comptes pour lesquels le signataire a un accès à l'API. Apparemment, elle inclut la clé d'autorisation de l'API. Pour être plus précis, avoir un accès à l'API signifie que le signataire doit se voir attribuer un rôle avec l'autorisation "Accès à l'API" dans ces sous-comptes.
Depuis la version 11.43, la même fonctionnalité est également prise en charge par le SDK.
SDK Java :
EslClient eslClient = new EslClient(API_KEY, API_URL) ; ListesubAccountApiKeys = eslClient.getAccountService().getSubAccountApiKeys() ;
nET SDK :
OssClient ossClient = new OssClient(apiKey, apiUrl) ; IListsubAccountApiKeys = ossClient.AccountService.getSubAccountApiKey() ;
Conclusion
Nous y voilà. Dans ce blog, nous avons présenté l'événement Javascript Notifier nouvellement introduit et nous vous avons présenté les récentes mises à jour et améliorations du SDK. Si vous avez des questions concernant ce blog ou tout autre sujet relatif à l'intégration de OneSpan Sign dans votre application, visitez les forums de la communauté des développeurs. Vos commentaires nous intéressent !