1. Code d’erreur (HTTP)

Pour les erreurs d’API je me suis inspiré de celles-utilisées dans la documentation de l’API de 42 ainsi que des principes de bases sur les codes de requêtes HTTP.

Chaque requête peut renvoyer un code d’erreur sous la forme du réponse HTTP, voici les codes utilisés par l’API:

• 400 → Bad request : Il y a une erreur de syntax dans la requêtes
• 401 → Unauthorized : Le client a tenté de faire des requêtes sans s’être authentifié
• 403 → Forbidden : Le client n’a pas les droits pour faire cette requête (par exemple utilisateur A qui essaie de modifier le mot de passe d’utilisateur B)
• 404 → Not found : Le client tente d’accéder à une ressource inexistante
• 500 → Internal Server Error : Le serveur n’a pas pu traiter la requête

En plus du code d’erreur la requête peut contenir un message sous la forme JSON tel que {”message”: “Le mot de passe a bien été mis a jour !”}. Les requêtes contenant des paramètres supplémentaires non-requis seront refusées et renverront un code d’erreur.

2. Structure de donnée

a faire

3. Point d’accès HTTP

Légende

Les arguments d’une requête tel que filter dans/dashboard?filter= sont en marron. Les clés des formulaires (valeur contenue dans le formulaire/body de la requête) tel que actualPassword tel que dans l’exemple sont en jaune

<form action="/dashboard?filter=password" method="post">
 			<input type="text" name="**actualPassword**"><br>
			<input type="submit" value="Changer le mot de passde">
</form>

Les requêtes précédées d’une 🔑 sont uniquement accessible aux utilisateurs connectés !

🔑 POST /api/dashboard

Permet de modifier les informations de l’utilisateur connecté . Cette requêtes prend obligatoirement en paramètre un filter !
Celui-ci peut-être de la valeur suivante:

password → actualPassword et newPassword

profilePicture → profilePicture

email → actualEmail et newEmail

gameTheme → gameTheme

Les messages d’erreurs susceptibles d’être retournés : Password do not match !, Form isn't valid ! Image is not valid ! En cas de succès la requête retourne un message.