Développeur OneSpan: introduction de l'API Sandbox pour l'authentification adaptative intelligente
L'API Sandbox Intelligent Adaptive Authentication (IAA) permet aux développeurs d'intégrer des solutions OneSpan, notamment Authentification adaptative intelligente , Analyse des risques , et Authentification Cloud OneSpan , au sein de leurs produits Web et mobiles pour mieux détecter les fraudes et améliorer l'expérience utilisateur. Vous pouvez utiliser l'API IAA Sandbox pour gérer les utilisateurs, valider les événements, attribuer des authentificateurs, approvisionner des appareils et bien plus encore.
Pour faciliter l'intégration, tous les services du IAA Sandbox adhèrent à l'architecture REST. De plus, il existe une page API interactive avec la documentation OpenAPI Swagger. Il contient des exemples pour vous aider à comprendre chacun des services et à créer vos charges utiles JSON afin d'explorer les différents points de terminaison. Dans ce blog, nous verrons comment accéder à la page API interactive et utiliser la documentation Open API Swagger.
Rejoignez la communauté OneSpan:
Avant d'explorer l'API interactive, vous devez être membre de la communauté OneSpan et ouvrir un compte sandbox IAA gratuit. Consultez notre blog précédent "Solutions Cloud OneSpan en action - Démo du portail Web MyBank, partie 1" pour savoir comment le faire.
Accéder à l'API interactive d'authentification adaptative
Tout d'abord, connectez-vous au Page Web de la communauté OneSpan . Ensuite, dans la barre de navigation dans le coin supérieur droit, survolez le menu déroulant qui affiche votre nom d'utilisateur, puis cliquez sur «Sandbox» qui vous dirigera vers la page des détails de votre compte Sandbox.
À partir de la page des détails du bac à sable, cliquez sur le lien intitulé «API interactive d'authentification adaptative», comme illustré dans la capture d'écran ci-dessous. Cela vous amènera à la page Web OpenAPI Swagger Interactive API.
En cliquant sur le lien ci-dessus, vous accédez à la page Web OpenAPI Swagger Interactive API ci-dessous.
La page Interactive Swagger API:
Dans la page API interactive, les points de terminaison seront regroupés par ressources. Par exemple, la ressource d'authentificateur englobera les points de terminaison à interroger, attribuer, annuler l'affectation et tous les points de terminaison pour gérer les authentificateurs comme indiqué ci-dessous. De la même manière, les autres ressources contiendront leurs points d'extrémité associés regroupés dans une approche logique.
La liste complète des ressources disponibles dans l'API interactive comprend:
• Authentificateurs
• Téléchargement de fichiers en masse
• Commandes de périphérique
• Événements
• Provisioning
• Sessions
• Transactions
• Utilisateurs
• Codes visuels
Chaque point de terminaison de l'API est marqué par sa méthode HTTP, qu'il s'agisse de Get, Post, Put, Delete ou Patch. Ces points de terminaison peuvent ensuite être testés à partir de l'API interactive IAA. De plus, l'éditeur OpenAPI Swagger vous donne la possibilité de modifier facilement les paramètres du chemin URL avec une description de chacun de ces paramètres. Cette fonction est illustrée dans la capture d'écran ci-dessous. Chacun de ces paramètres sera marqué d'un astérisque lorsqu'il est requis pour chaque point de terminaison.
De plus, l'API interactive présentera la structure attendue et des exemples pour
• Le corps de requête JSON pour chaque point de terminaison
• Le corps de réponse JSON pour chaque point de terminaison
• Le code de réponse attendu pour un appel de service Web réussi ou erroné. Par exemple, un exemple de code de réponse 200 qui indique une requête réussie ou un exemple de code de réponse 400 qui indique une erreur de données d'entrée.
Les schémas API interactifs
L'une des sections les plus importantes de l'API interactive est la section Schéma. À l'intérieur, vous trouverez tous les attributs qui peuvent être utilisés pour chaque point de terminaison unique. Ils seront répertoriés avec leurs types de données et un exemple pour chacun des champs de données. Vous remarquerez que les attributs requis sont marqués d'un astérisque rouge. Si un attribut n'a pas l'astérisque, il s'agit d'un attribut facultatif, qu'il n'est pas nécessaire de fournir lorsqu'il n'est pas nécessaire dans le corps de la demande.
En savoir plus sur les forums du portail communautaire
Ce billet de blog était une introduction à l'API IAA Sandbox. Nous avons vu comment la page API interactive est structurée avec un exemple de modèle pour chaque appel de noeud final, comment les noeuds finaux sont regroupés en ressources et comment explorer le schéma des champs de données. Dans les prochains blogs, nous explorerons chacun des points de terminaison individuellement. En attendant, si vous avez des questions, veuillez nous contacter sur le Forums du portail communautaire .
OneSpan Sign Developer Community
Rejoignez la communauté OneSpan Sign Developer! Forums, blogs, documentation, téléchargements SDK, et plus encore.
Joignez-vous aujourd'hui