Migration d'Authy vers Verify pour l'A2F par SMS

May 23, 2022
Rédigé par

L'API Verify est une version améliorée de l'API Authy avec une prise en charge continue des codes d'accès à usage unique par SMS, voix et e-mail. Elle présente une expérience améliorée pour les développeurs ainsi que de nouvelles fonctionnalités. Twilio prendra en charge l'API Authy jusqu'au 1er novembre 2022. Après cette date, nous commencerons à retirer le service SMS/Voice. Toutes les requêtes envoyées à l'API après le 1er mai 2023 recevront automatiquement une erreur.

Voici quelques-unes des fonctionnalités de l'API Verify :

  • Librairies Twilio dans JavaScript, Java, C#, Python, Ruby et PHP
  • SDK d'authentification Push intégrables dans votre app
  • Limites de taux programmables
  • Visibilité et informations améliorées

... et plus encore !

Cet article s'applique à l'API Authy. L'app Authy ne va pas disparaître. Nous nous engageons à faire évoluer, développer et soutenir Twilio App Authy en tant qu'application grand public et en complément de notre travail sur l'API Verify.

Ce guide présente l'API Verify et un ensemble de directives pour migrer votre application d'Authy vers Verify.

API Verify de base

Verify est maintenant hébergée sur API de Twilio. La nouvelle URL de base est :

https://verify.twilio.com/v2/

Utilisez vos identifiants Twilio pour vous authentifier

L'API Authy requiert une clé d'API Authy. L'API Verify V2 utilise vos identifiants Twilio disponibles dans la console, comme dans la requête suivante :

curl -XPOST https://verify.twilio.com/v2/Services \
    -d FriendlyName=MyServiceName \
    -u '[YOUR ACCOUNT SID]:[YOUR AUTH TOKEN]'

 

De meilleurs outils de développement, y compris les librairies Twilio

Contrairement à l'API Authy, les librairies Twilio prennent en charge l'API Verify. Vous n'avez plus besoin des librairies Authy séparées. Nous prenons officiellement en charge les librairies pour C#JavaPHPPythonRubyNode.js et Golang [Pilot].

Verify fait également partie de l'interface de ligne de commande de Twilio et de la nouvelle spécification Open API. Consultez notre référence d'API pour des exemples et plus d'informations.

Exemples de migration

Pour obtenir des exemples de code de migration de l'A2F par SMS d'Authy vers Verify, consultez les différences de code suivantes :

 

Les applications sont maintenant des Services

Verify utilise les Services pour la configuration. Avec l'API Authy, vous avez créé une application Authy et utilisé cette clé d'API pour gérer les vérifications. Dans Verify, vous aurez besoin de vos identifiants Twilio et d'un Service SID. Vous pouvez créer et mettre à jour un Service de deux manières :

  1. Avec l'API Verify
  2. Dans la console Verify

Les applications héritées (Legacy Applications) ont été partagées entre Verify et Authy, de sorte que vous pouvez voir une « application » dans la console Verify. Les Services sont la nouvelle méthode de configuration et vous devez vous trouver dans l'onglet Services pour commencer à utiliser Verify V2.

Visibilité et aperçus améliorés

Fonctionnalité disponible uniquement avec notre nouvelle API Verify, affichez l'état de vos vérifications dans la console, y compris l'état de remise des messages.

Logs montrant les statuts des tentatives de vérification : "en attente", "approuvés", "expiré" et "nombre de tentatives maximum atteint"

Gestion des erreurs

Les codes d'erreur Verify sont différents des codes d'erreur Authy et ils peuvent être trouvés dans la documentation. Les erreurs courantes sont les suivantes :

 

Utilisez un numéro de téléphone au format E.164 au lieu d'un ID Authy

Les ID Authy ont été utilisés comme paramètre pour envoyer des vérifications SMS avec l'API Authy.

Dans Verify, les vérifications sont lancées avec des numéros de téléphone au format E.164, comme suit : +15552317654. Consultez l'API Lookup pour obtenir des exemples sur la façon de convertir les numéros au format national au format E.164.

Bonnes pratiques de migration

Utilisez Lookup pour convertir les numéros de téléphone au format E.164

L'API de formatage gratuite Lookup vous fournira deux informations utiles :

  1. Le numéro de téléphone au format E.164 : le format requis pour la vérification en cours.
  2. Le code pays au format ISO 3166 alpha-2 (ex. US, CA, BR, etc.). Ceci est nécessaire pour créer une liste d'autorisation ou de blocage des pays.

Stockez le numéro de téléphone au format E.164 et le pays dans votre base de données pour une utilisation ultérieure.

Pour en savoir plus, consultez la documentation Lookup.

Définir les pays autorisés

Si vous disposez d'une base d'utilisateurs mondiale, vous pouvez autoriser tous les pays. Si vous attendez du trafic provenant de quelques pays seulement, vous pouvez créer une liste d'autorisation pour aider à limiter la fraude. Vous pouvez également créer une liste de blocage s'il y a des pays dont vous n'attendez pas de trafic.

Supprimer l'utilisateur Authy de votre application

Après avoir migré un utilisateur, nous vous recommandons de supprimer l'utilisateur Authy de l'application héritée. Vous trouverez des instructions sur la suppression des utilisateurs Authy dans la documentation.

FAQ

Que se passe-t-il si nous n'avons enregistré que l'ID Authy et que nous n'avons pas le numéro de téléphone de l'utilisateur ?

Nous avons une API pour cela ! Pour en savoir plus, consultez la documentation de l'Export API.

Si vous avez besoin d'aide, contactez-nous et nous pourrons vous présenter vos options.

Pourquoi est-ce que j'obtiens le même code avec les nouvelles requêtes de vérification en utilisant Verify ?

Les tokens Verify sont valides pendant 10 minutes et le code d'accès ne change pas pendant cette période. Pour forcer un nouveau code d'accès, terminez le cycle de vérification ou annulez la vérification.

Les limites de taux sont-elles différentes dans Verify ?

Les limites de taux présentent des différences subtiles dans Verify par rapport à Authy.

Les limites de taux pour Verify SMS sont les suivantes :

  • 5 tentatives de vérification d'envoi en 10 minutes [plus d'infos].
  • 5 tentatives de vérification de contrôle [plus d'infos].

Veuillez contacter le service des ventes ou l'assistance technique pour plus d'informations sur les limites de taux. La plupart des clients trouvent les limites de taux par défaut de Verify suffisantes, mais vous pouvez également protéger votre application en ajoutant des limites de taux de service.

Comment puis-je tester Verify sans limitation ?

Consultez le blog post sur Comment tester Twilio Verify sans limitation.

 

Verify prend-elle en charge le TOTP ?

Oui. Apprenez-en plus sur l'implémentation du TOTP dans la documentation ou essayez le TOTP avec le CodeExchange de Twilio.

Verify prend-elle en charge Push ?

Oui. L'assistance Push est en phase d'essai. Contactez-nous pour y accéder et en savoir plus.

 

Verify dispose-t-elle d'une API de reporting ?

L'API Verify Attempts est également en phase d'essai et propose des fonctionnalités de reporting. Contactez-nous pour en savoir plus.