Interfaccia API - Verificazione di un annuario utenti (LDAP)

Interfaccia API - Verificazione di un annuario utenti (LDAP)

L'implementazione della verifica degli indirizzi e-mail da parte di una API è accessibile dalla licenza Oro.

Presentazione

Per potere verificare l'esistenza di un utente, possiamo interfacciarci con un API che ci informerà sulla validità di una mail indicata. Per procedere, interroghiamo un servizio web HTTP(S) in POST con un header "X-Token" per autorizzare soltanto il nostro servizio ad interrogare la vostra API e due parametri "mail" e "resource_id" nel body della richiesta contenendo la mail da verificare. Il servizio web risponde in JSON con un booleano (true/false) "user_valid".

Procedura

In sintesi, questa è la procedura tappa per tappa:

1. Un utente effettua una prenotazione sul sito o sulla mobile app.
2. Realizziamo una richiesta per verificare la mail indicata:

1. Protocollo: HTTP o HTTPS
2. URL: URL che ci indicate
3. Header: X-Token: Token da creare
4. Body:

  1. {
  2. "mail" : "user@mail.com",
  3. “resource_id” : 123
  4. }

Esempio di richiesta 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.   }'

Risposta

Secondo la risposta (indirizzo mail esistente, utente valido...), il servizio web invia una risposta:

  • Se l'utente è valido : {"user_valid":true}
  1. {
  2. “user_valid” : true
  3. }
  • Se l'utente non è valido
  1. {
  2. “user_valid” : false
  3. }