Ouverture d’une session PHyC¶
Ce web-service permet d’ouvrir une session en PHyC à partir d’un login et mot de passe.
Le login peut être soit le code contact, l’alias du contact ou encore son adresse mail.
Pour des raisons de sécurité, l’authentification par mot de passe est désactivé au bout de 50 erreurs de mot de passe consécutives.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
session |
Méthode |
POST |
Paramètres¶
Nom |
Description |
Type |
O/F |
|---|---|---|---|
idcontact |
Identifiant de l’utilisateur |
str |
O |
motdepasse |
Mot de passe |
str |
O |
filtre |
types d’authentification |
list(str) |
F |
contact |
Publication d’infos du contact |
bool |
F |
Paramètre filtrelogin¶
Ce paramètre est facultatif. S’il n’est pas fourni, l’utilisateur peut s’authentifier soit à partir d’un code contact, d’un alias ou d’une adresse mail.
Le paramètre filtrelogin est de type tableau. Les filtres de login autorisés sont:
cdcontact
alias
email
Si le paramètre filtrelogin contient un champ différent de ceux autorisés, le web-service renverra une erreur concernant le champ filtrelogin.
Si par exemple filtrelogin contient uniquement la chaîne email, l’authentification est réalisée à partir de l’adresse mail.
Paramètre publiercontact¶
Le paramètre publiercontact est facultatif. S’il n’est pas fourni, le web-service renverra un xml contenant les informations du contact.
Si publiercontact est à vrai, le web-service renverra dans le champ xmlprevcrues, les informations liées au contact. Son contenu correspond au retour du web-service publierContactListe avec comme paramètre le code contact.
Retour web-service¶
Le web-service renverra un objet json avec les propriétés suivantes:
idsession: l’identifiant de session
cdcontact: code contact associé à la session
json: un json hydrométrie contenant les principales informations du contact: nom, prenom, mail,…