Interfaz API - Verificación de un directorio de usuario (LDAP)

Interfaz API - Verificación de un directorio de usuario (LDAP)

La comprobación de las direcciones de e-mail por una API es objeto de una prestación específica.

Presentación

Para verificar la existencia de un usuario, podemos interactuar con una API que nos informa de la validez de la dirección de correo electrónico indicada. Para ello, interrogamos un servicio web HTTP(S) en POST con un header "X-Token" para autorizar únicamente a nuestro servicio la interrogación de su API y dos parámetros "mail" y "resource_id" en el body de la consulta que contiene la dirección de correo electrónico a comprobar. El servicio web responde en JSON con un booleano (true/false) "user_valid".

Proceso

En resumen, este es el proceso paso a paso:

  1. Un usuario realiza una reserva en el sitio web o en la aplicación móvil
  2. Creamos una solicitud para comprobar la dirección del email indicada:
    1. Protocolo: HTTP o HTTPS
    2. URL: URL que nos transmitirá
    3. Header: X-Token: token que usted genera
    4. Body:
  1. {
  2. "mail" : "user@mail.com",
  3. “resource_id” : 123
  4. }

Ejemplo de consulta 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.   }'

Respuesta

En función del resultado (dirección existente, usuario válido, etc.), el servicio web reenvía una respuesta:

  • Si el usuario es válido: {"user_valid":true}
  1. {
  2. “user_valid” : true
  3. }
  • Si el usuario no es válido
  1. {
  2. “user_valid” : false
  3. }