Mettre en oeuvre l'API RemAuth

RemAuth ne nécessite pas d'installation pour sa mise en oeuvre. En effet, le service est principalement constitué d'une API HTTP qui supporte le procédé d'authentification sans mot de passe et de gestion de session.

De même, par défaut, l'utilisateur final utilise ses outils habituels que sont sa messagerie et son téléphone mobile. Mais il peut également utiliser l'application RemAuth Control qui lui apportera le confort du temps réel à l'instar d'une authentification intégrée.


Définissez votre première configuration RemAuth

Procédure

Il suffit d'ouvrir un compte RemAuth et de définir son premier service. C'est immédiat, gratuit et bien sûr sans mot de passe :

  1. Rendez-vous à l'Espace Client et créez un compte avec une simple adresse email.
  2. Rendez-vous à la rubrique SERVICE et cliquez sur Nouveau Service.

Dans un deuxième temps, vous pourrez personnaliser les différents paramètres et notamment nous vous engageons à définir les éléments relatifs à l'identité de votre service (nom, visuel, web, contact...).

Exemple de propriétés d'un service

Voici les propriétés principales et leur valeur par défaut du service démontré dans la Démo détaillée.


                    

Faites votre premiere requête à l'API RemAuth

Si vous êtes déjà familier avec les API HTTP et/ou REST, vous ne serez pas dépaysé : RemAuth expose une API HTTP standard avec son guide de référence avec lequel vous pourrez tout tester.

caractéristiques de l'API RemAuth

  • L'URL du serveur est https://api.remauth.com
  • Les méthodes HTTP supportées sont GET et POST.
  • Les données sont de type JSON.
  • Les codes d'erreur HTTP ne concernent que les erreurs standard relatives aux problèmes d'aboutissement des requêtes (ex. 403, 502...).
  • Pour les requêtes qui aboutissent normalement, les réponses sont des objets qui ont tous le format suivant : {code: "200", msg: "OK", data: "Any data"}
    • code est un code de réponse qui vaut "200" en cas de réponse nominale.
    • msg est un court message associé au code qui vaut "OK" en cas de réponse nominale.
    • data est la réponse à proprement parler.

    Cette approche permet de garantir la confidentialité des échanges (y compris les erreurs) dans un environnement ouvert.

    C'est pour cette même raison que dans un contexte de communication SSL/TLS la méthode POST est, tant que possible, préférée à la méthode GET.

Exemple de requête en cURL

Le code suivant appelle la fonction POST /version avec en paramètre l'identifiant de service précédemment défini.

curl -X POST -H 'Content-Type: application/json'  -d '{"key":"d97b3e6639f048c1bd6cce939b22fd43"}' 'https://api.remauth.com/version'

La réponse est le numéro de version courante du serveur d'API :

{code: "200", msg: "OK", data: "1.5"}

En cas d'erreur dans les paramètres, on obtient alors une réponse avec un code différent de "200" comme dans l'exemple suivant :

curl -X POST -H 'Content-Type: application/json' -d '{"key":"d97b3e6639f048c1bd6cce93WrongKey"}' 'https://api.remauth.com/version'
{code:"605",msg:"Unknown or invalid service key.",data:"d97b3e6639f048c1bd6cce93WrongKey"}

De par ses caractéristiques, l'API RemAuth est donc utilisable à partir de n'importe quel langage de programmation qui permet d'effectuer des requêtes HTTP.

Exemples de requêtes à partir de langages serveur

Objectif : Appel de la fonction POST /access pour créer un jeton d'accès à durée de vie limitée, à partir d'une clé et d'un code secret de service.

Exemple en PHP

Voir la démo à cette addresse.

                                                                                
 
 
Exemple en Node.js

L'exemple utilise le package request installable par la commande npm install request.

                                                                                
     
 

Exemple de requête à partir d'un navigateur

Nous reprenons ici l'exemple de l'API /version appelée par un navigateur à partir d'un domaine quelconque.

L'exemple s'appuie sur la librairie jQuery afin de réaliser les appels AJAX cross-domain.