PYSAE expose une API HTTPS permettant d’interagir avec le système. Un certain nombre de endpoints requièrent une authentification.
Les requêtes sont authentifiées grâce à un cookie contenant un identifiant de session (session_id).
Un identifiant de session peut être obtenu via l’API en envoyant un email et un mot de passe. Les autorisations d'accès aux données de l'API sont liées aux rôles des utilisateurs.
Obtention d'un identifiant de session
L’obtention d’un identifiant de session se fait par le endpoint:
La requête doit être une requête POST avec un contenu au format "application/x-www-form-urlencoded" contenant les champs email et password.
Exemple:
Host: pysae.comContent-Type: application/x-www-form-urlencodedemail=utilisateur@example.com&password=motdepasse
Si les information de login (email et mot de passe) sont bonnes, un objet JSON est renvoyé avec un propriété session_id contenant l’identifiant de session. Sinon un code HTTP 401 est retourné.
Exemple de réponse de requête réussie:
{ "session_id": "TXMC4cBiynnkPFBK9ND2E1oc", "expires_days": 20}Utilisation de l'identifiant de session pour interroger l'API
Pour accéder à un endpoint sécurisé de l'API dans votre requête vous devez ajouter un header de type "Authorization" avec la valeur : "Bearer <session_id>", soit par exemple "Bearer TXMC4cBiynnkPFBK9ND2E1oc".