Interfaçage API - Vérification d'un annuaire utilisateur (LDAP)

Interfaçage API - Vérification d'un annuaire utilisateur (LDAP)

La mise en place de la vérification des adresses email par une API fait l'objet d'une prestation spécifique.

Présentation

Afin de vérifier l’existence d'un utilisateur, nous pouvons nous interfacer avec une API qui nous informe de la validité de l'adresse mail renseignée. Pour ce faire, nous interrogeons un service web HTTP(S) en POST avec un header "X-Token" pour autoriser seulement notre service à interroger votre API et deux paramètres "mail" et "resource_id" dans le body de la requête contenant l'adresse mail à vérifier. Le service web répond en JSON avec un booléen (true/false) "user_valid".

Processus

En synthèse, voici le processus étape par étape :

  1. Un utilisateur effectue une réservation sur le site web ou sur l'application mobile
  2. Nous construisons une requête pour vérifier l'adresse mail renseignée :
    1. Protocole : HTTP ou HTTPS
    2. URL : URL que vous nous communiquerez
    3. Header : X-Token : token que vous générez
    4. Body :
  1. {
  2. "mail" : "user@mail.com",
  3. “resource_id” : 123
  4. }

Exemple de requête curl :

  1. curl -X POST \
  2.   https://validation-url.com/ \
  3.   -H "Accept: application/json" \
  4.   -H "Content-Type: application/json" \
  5.   -H "X-Token: random-token" \
  6.   -d '{
  7.     "mail" : "utilisateur@etablissement.com",
  8.     “resource_id” : 123
  9.   }'

Réponse

En fonction du résultat (adresse existante, utilisateur valide, ...), le service web renvoie une réponse :

  • Si l'utilisateur est valide : {"user_valid":true}
  1. {
  2. “user_valid” : true
  3. }
  • Si l'utilisateur n'est pas valide
  1. {
  2. “user_valid” : false
  3. }