Skip to content

L'API Reach Authentix

L'API Reach Authentix de TalkyLabs vous permet d'ajouter facilement une deuxième couche de sécurité à vos applications et de permettre la vérification des utilisateurs via plusieurs canaux.

Information Circle

Pour l'instant, l'API Reach Authentix prend en charge les canaux suivants :

  • SMS

  • Email

Nous travaillons continuellement à l'ajout de canaux supplémentaires.

URL de base

L'API Reach Authentix de TalkyLabs est désservie par HTTPS en utilisant l'URL de base suivante :

https://api.reach.talkylabs.com/rest/authentix/v1

Authentification

Toutes les requêtes adressées à l'API doivent être authentifiées. L'API Reach Authentix de TalkyLabs utilise la clé API comme mécanisme d'authentification.

Utilisez simultanément votre Utilisateur API et Clé API (les deux informations se trouvent dans la console) afin de vous authentifier lorsque vous envoyez des requêtes à la plateforme Reach.

L' Utilisateur API sert d'identifiant à votre Applet tandis que la Clé API, en plus de servir de mot de passe, permet de déterminer la configuration dans laquelle vos requêtes opèrent.

La plateforme Reach définit deux modes de fonctionnement et vous permet de naviguer d'un mode à l'autre en toute simplicité:

  • Mode sandbox
  • Mode production

Mode sandbox

Le mode sandbox vous permet de tester facilement et gratuitement l'intégration de votre application avec la plateforme Reach.

Pour opérer dans ce mode, il suffit d'utiliser la Clé API de Test en conjonction avec l'Utilisateur API lors de l'envoi des requêtes à la plateforme Reach.

Mode production

Une fois que vous êtes satisfait de votre intégration et que vous souhaitez passer en mode production, vous pouvez facilement le faire en utilisant simplement la Clé API Live.

Là encore, l' Utilisateur API, la Clé API de Test et la Clé API Live se trouvent dans la console.

Les exemples de code dans la documentation de l'API montrent comment fournir vos informations d'identification lorsque vous utilisez curl ou une bibliothèque cliente pour interagir avec la plateforme Reach. Dans l'extrait ci-dessous, nous montrons un exemple de la façon dont cela est fait en utilisant curl.

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/configurations -H "ApiUser : <UTILISATEUR_API>" -H "ApiKey : <CLE_API>"

Vous devez fournir l' UTILISATEUR_API et la CLE_API associés à votre applet. Ces informations peuvent être trouvées dans les paramètres de l'applet.

Comment fonctionne l'API Reach Authentix ?

Trois étapes sont nécessaires pour vérifier un utilisateur donné en utilisant l'API Reach Authentix.

Etape 1 : Créer une configuration Authentix

Une configuration Authentix est un ensemble de paramètres utilisés pour définir et envoyer un code d'authentification à un utilisateur. Cela inclut, par exemple:

Information Circle
  • la longueur du code d'authentification,
  • le modèle de message,
  • et ainsi de suite...

Une configuration peut être créée via l'application web ou directement en utilisant l'API Reach Authentix. Cette étape n'a pas besoin d'être réalisée à chaque fois que l'on souhaite utiliser l'API. En effet, une fois créée, une configuration peut être utilisée pour vérifier plusieurs utilisateurs à l'avenir.

Étape 2 : Envoi d'un code d'authentification

Une configuration est utilisée pour envoyer un code d'authentification via le canal sélectionné à un utilisateur. Pour l'instant, les canaux supportés sont sms, et email. Nous travaillons dur pour supporter d'autres canaux. Les authentifications nouvellement créées auront le statut awaiting.

Étape 3 : Vérification du code d'authentification

Cette étape permet de vérifier que le code soumis par l'utilisateur correspond à celui envoyé précédemment. S'il y a correspondance, le statut de l'authentification passe de awaiting à passed. Dans le cas contraire, le statut reste à awaiting jusqu'à ce qu'il soit vérifié ou qu'il expire. Dans ce dernier cas, le statut devient expired.

Pagination

La plateforme Reach utilise une pagination basée sur le décalage pour lister les objets.

Par exemple, si une requête de recherche a un résultat de 100 objets avec pageSize = 10 et page = 5, alors les objets ayant les indices 51 à 60 sont retournés.

Les bibliothèques clientes introduisent le paramètre limit qui peut être utilisé pour indiquer le nombre maximum d'objets satisfaisant les critères spécifiés à retourner.

Débuter avec l'API Reach Authentix

Il est très facile de commencer à utiliser l'API Reach Authentix de TalkyLabs. Il vous suffit de sélectionner votre langage de programmation préféré et de coder. Nous disposons de plusieurs bibliothèques clientes et de tutoriels afin de faciliter vos débuts. L'exemple de code ci-contre montre comment démarrer un processus d'authentification en utilisant l'API Reach Authentix. En explorant l'API, vous verrez à quel point il est facile de vérifier l'exactitude du jeton d'authentification et de gérer vos configurations Authentix. Notez également que vous pouvez aussi gérer vos configurations dans la console web.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications --data-urlencode "dest=+237671234567" --data-urlencode "channel=sms" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"

Bibliothèques clientes

Vous pouvez interagir avec l'API Reach Authentix de TalkyLabs en utilisant votre langage de programmation préféré.

Pour obtenir un guide étape par étape sur la façon de commencer avec une bibliothèque cliente, sélectionnez l'un des liens ci-dessous :

Information Circle