🔐Authentification

L'api de Yaprof est sécurisé par un système d'authentification.

Informations

Notre API permet de faire fonctionner l'application, il est donc important de l'utiliser avec bon escient pour éviter toutes pannes. Merci de votre compréhension.

Utilisation

Si vous souhaitez utiliser l'api, munissez-vous du repository Github ou bien d'une plateforme d'api comme Postman. Pour la plupart des requêtes, l'api vérifie le token de l'utilisateur ainsi que les informations sur ce dernier afin de sécuriser et mettre à jour les informations liés à notre DB ou bien celle de Pronote.

Voici un exemple de requête utilisant les paramètres d'authentification :

Récupère les informations liées à l'utilisateur Pronote

POST https://api.yaprof.fr/getInfos

Headers

Name	Type	Description
Authorization*	Bearer JWT token

Request Body

Name	Type	Description
userInfos*	JWT Token

200: OK En cas de réponse positive, les informations sont renvoyées.

{
    name: "Alexandre VARGAS LOPEZ",
    pp: "https://res.cloudinary.com/dzg9awmm8/image/upload/v1681944731/user/icons/VARGAS%20LOPEZ%20Alexandre.jpg",
    class: "2DE 03",
    etab: "Lycée Amiral de Grasse",
    role: 0
}

400: Bad Request Si cette réponse apparait, il est problable que vous ayez oublié un paramètre requis.

{
    error: "Token invalide"
}