OneSpan Sign How To: Mise en place de rappels

Si vous utilisez un auditeur pour réagir aux notifications envoyées par OneSpan Sign lorsque certains événements se produisent avec un paquet, vous devrez configurer votre URL de rappel dans Le Signe OneSpan et indiquer les notifications auxquelles vous souhaitez vous abonner. Vous pouvez également configurer une clé de sécurité facultative pour sécuriser davantage la transaction de rappel. Dans ce blog, je vais montrer comment le faire avec le Java SDK, .NET SDK, et l'API REST.

Avant de commencer

Avant de commencer, il ya quelques choses qui seront utiles pour savoir avant de définir l'un de ces up et de test.

OneSpan Sign Developer Community

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

Joignez-vous aujourd'hui

Emplacement dans l'interface uI

Tout d'abord, vous devriez localiser cette zone dans votre interface uI. Après avoir exécuté votre code, vous serez en mesure de vérifier ici pour s'assurer qu'il a fonctionné avec succès. Pour trouver la zone de rappel de l’interface uI, connectez-vous à OneSpan Sign et rendez-vous sur ACCOUNT dans la barre d’outils. Sous la clé API, vous verrez la section Notification d'événement.

Comme vous le verrez, cette zone est complètement vide (sauf si vous avez déjà mis en place). Bien sûr, vous pouvez toujours simplement définir ces valeurs, ici, dans l'interface du monde. Si c'est assez bon pour vous, vous pouvez arrêter de lire, maintenant. 

Notifications disponibles

Avant de passer au code, il serait bon de connaître toutes les notifications disponibles. Comme vous pouvez le voir dans l'image ci-dessus, il y en a plusieurs. Le tableau suivant les énumère au fur et à mesure qu'ils doivent être représentés, dans votre code :

Vous pouvez trouver plus d'informations sur le contenu de chaque notification, ici.

Le code

Comme je l'ai indiqué ci-dessus, je vais montrer comment le faire avec le Java SDK, .NET SDK, et avec l'API REST. Allez-y et sautez à la section qui vous intéresse, ci-dessous. Ils incluront tous la même information seulement qu'il sera pour cette technologie spécifique, donc pas besoin de scanner ceux qui ne vous intéressent pas.

Java SDK

Je vais commencer avec le Java SDK. Vous trouverez ci-dessous une classe Java simple qui définit l'URL de rappel, la clé de rappel et vous acquière à trois notifications d'événements différentes. Assurez-vous de modifier le API_KEY, l'URL et le CEI à vos propres valeurs. Vous pouvez également ajouter plus d'abonnements de notification à partir de la table d'options, ci-dessus.

paquet com.esignlive.exemple;

import com.silanis.esl.sdk.EslClient;
import com.silanis.esl.sdk.NotificationEvent;
import static com.silanis.esl.sdk.builder.EventNotificationConfigBuilder.newEventNotificationConfig;

classe publique SetCallbackURLAndKey (en) 
    finale statique privée String API_KEY "YOUR_API_KEY";
    finale statique privée String API_URL "https://sandbox.esignlive.com/api"; USE https://apps.e-signlive.com/api POUR PRODUCTION
    URL de chaîne finale statique privée "http://my.url.com";
    finale statique privée String KEY - "myCallbackKey";
 
    public statique vide principal( String[] args )
        EslClient eslClient - nouveau EslClient ( API_KEY, API_URL);
        eslClient.getEventNotificationService().register(newEventNotificationConfig(URL)
                .withKey(KEY)
                .forEvent (NotificationEvent.PACKAGE_CREATE)
                .forEvent (NotificationEvent.PACKAGE_DECLINE)
                .forEvent (NotificationEvent.PACKAGE_COMPLETE));    
    }
}

Allez-y et passez à la section "Les résultats", si vous n'êtes pas intéressé à le faire avec l'API .NET SDK ou REST.

SDK .NET

Ensuite, je vais couvrir le .NET SDK. Vous trouverez ci-dessous une classe CMD qui définit l'URL de rappel, la clé de rappel et vous acquière à trois notifications d'événements différentes. Assurez-vous de modifier le API_KEY, l'URL et le CEI à vos propres valeurs. Vous pouvez également ajouter plus d'abonnements de notification à partir de la table d'options, ci-dessus.

en utilisant le système;
en utilisant Silanis.ESL.SDK;

namespace SetCallbackUrlAndKey
{
    classe SetCallbackUrlAndKey
    {
        apiUrl de chaîne statique privée -"https://sandbox.esignlive.com/api";
        apiKey de chaîne statique privée - "YOUR_API_KEY";
        URL de chaîne statique privée "http://my.url.com";
        clé de chaîne statique privée - "myCallbackKey";

        public statique vide Main(corde[] args)
        {
            EslClient eslClient - nouveau EslClient (apiKey, apiUrl);
            eslClient.EventNotificationService.Register(EventNotificationConfigBuilder.NewEventNotificationConfig(URL)
                . WithKey(KEY)
                . ForEvent (NotificationEvent.PACKAGE_CREATE)
                . ForEvent (NotificationEvent.PACKAGE_DECLINE)
                . ForEvent (NotificationEvent.PACKAGE_COMPLETE));
        }
    }
}

Allez-y et passez à la section " Résultats ", si vous n'êtes pas intéressé à le faire avec l'API REST.

API REST

Enfin, je vais montrer comment le faire avec l'API REST. Vous trouverez ci-dessous une classe simple de CMD qui exécute une demande POST pour définir l'URL de rappel, la clé de rappel et vous abonner à trois notifications d'événements différentes. Assurez-vous de modifier le API_KEY, l'URL et le CEI à vos propres valeurs. Vous pouvez également ajouter plus d'abonnements de notification à partir de la table d'options, ci-dessus.

en utilisant le système;
l’utilisation de System.Net;
en utilisant System.Net.Http;
en utilisant System.Net.Http.Headers;
en utilisant System.Text;

namespace SetCallbackUrlAndKeyREST
{
    classe SetCallbackUrlAndKeyREST
    {
        apiUrl de chaîne statique privée -"https://sandbox.esignlive.com/api";
        apiKey de cordes statiques privées "aDhrM0R3a1hJcmtBOkE3V1ljN0d4V3hvRg" ;
        URL de chaîne statique privée "http://my.url.com";
        clé de chaîne statique privée - "myCallbackKey";

        public statique vide Main(corde[] args)
        {
            Contenu de la chaîne ' '''url'''''''''''''''''' '' ' PACKAGE_COMPLETE PACKAGE_DECLINE PACKAGE_CREATE ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '
            StringContent json - nouveau StringContent (contenu, Encoding.UTF8, "application/json");
            HttpClient myClient '  nouveau httpClient();
            myClient.DefaultRequestHeaders.Authorization - new AuthenticationHeaderValue ("Basic", apiKey);
            myClient.DefaultRequestHeaders.Add("Accept", "application/json,text/html, application/xhtmlxml,application/xml;q'0.9,' /;q'0.8");
            var réponse - myClient.PostAsync (nouveau Uri (apiUrl - "/callback"), json). Résultat;
        }
    }
}

Le résultat

Si vous exécutez le code de l'une des trois sections ci-dessus, c'est le résultat que vous verrez si vous retournez à la zone de notification d'événement dans l'interface utilisateur que nous avons regardé dans la section « Avant de commencer ».

C’est tout. Vous avez maintenant vos notifications de rappel mis en place pour votre auditeur de réagir.

Merci pour la lecture! Si vous avez des questions ou il ya des sujets que vous aimeriez voir couvert dans mon blog, n'hésitez pas à poster dans la section commentaires.

Michael Williams
Twitter - France Facebook - France LinkedIn (en)