API-Schnittstelle - Überprüfen eines Benutzerverzeichnisses (LDAP)

API-Schnittstelle - Überprüfen eines Benutzerverzeichnisses (LDAP)

Die Installierung der Überprüfung der E-Mail-Adressen über eine API ist ab der Gold-Lizenz verfügbar.

Einführung

Um die Existenz eines Benutzers zu prüfen, können wir uns mit einer API verknüpfen, die uns über die Gültigkeit der gespeicherten E-Mail-Adresse informiert. Dazu befragen wir einen HTTP(S)-Webdienst in POST mit einem "X-Token"-Header, damit nur unser Dienst Ihre API befragen kann, und mit zwei Parametern "mail" und "resource_id" im Request Body, die die zu prüfende E-Mail-Adresse enthält. Der Webdienst antwortet in JSON mit einer booleschen Variable (true/false) "user_valid".

Prozess

Zusammengefasst ist hier die schrittweise Vorgehensweise :

  1. Ein Benutzer nimmt eine Reservierung auf der Internetseite oder in der mobilen App vor
  2. Wir erstellen eine Anfrage zur Überprüfung der angegebenen E-Mail-Adresse :
    1. Protokoll : HTTP oder HTTPS
    2. URL : die von Ihnen kommunizierte URL
    3. Header : X-Token : das von Ihnen generierte Token
    4. Body :
  1. {
  2. "mail" : "user@mail.com",
  3. “resource_id” : 123
  4. }



Beispiel einer curl Abfrage :

  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.   }'

Antwort

Je nach Ergebnis (vorhandene Adresse, gültiger Benutzer, ...) schickt der Webservice eine Antwort:

  • Wenn der Benutzer gültig ist: {"user_valid":true}
  1. {
  2. “user_valid” : true
  3. }
  • Wenn der Benutzer nicht gültig ist :
  1. {
  2. “user_valid” : false
  3. }
 

    • Related Articles

    • Technischer Fragebogen zur Installierung eines Software-Anschlusses

      Mit diesem Fragebogen unserer IT-Abteilung kann festgestellt werden, ob und wie eine Schnittstelle zwischen unserem Verwaltungssystem und Ihrer Messdaten eingerichtet werden kann. Abruf der Frequenz-Historie Besitzen Sie die folgenden Informationen ...

    • WebAPI zur Auslastungsanzeige : Integration und Personalisierung

      Einleitung Unter dem Begriff “WebAPI” verstehen wir einige Module, die in den Code einer Internetseite integriert werden, um folgende Informationen als Widget anzuzeigen : Die Besucheranzahl der Einrichtung in Echtzeit (Auslastungsgrad oder ...

    • Statistiken

      Das Statistikmodul ist ab der Silber-Lizenz verfügbar. In der Kategorie Statistiken können Sie die Statistiken Ihrer Einrichtung einsehen. Diese Statistiken basieren auf den Messungen von den in der Einrichtung installierten Sensoren (Affluences ...

    • Verwaltung

      Unter der Kategorie “Verwaltung” können Sie die Informationen Ihrer Einrichtung einfach verwalten und bearbeiten.  Informationen verwalten In der Kategorie Informationen verwalten können Sie alle allgemeinen Informationen Ihrer Einrichtung angeben : ...

    • Reservierunssystem

      Wenn eine Einrichtung ihre Ressourcen zur Buchung zur Verfügung stellt, können Nutzer diese mit wenigen Klicks über die Affluences-App buchen (verfügbar auf Android und iOS oder über die Internetseite www.affluences.com). Der Zugang zum ...