README.org

Projet MiageTch@t

Table of Contents

Team

• Ganeistan
• Inkaran

Contexte

Nous avons choisi parmi les projets disponibles (Dames, Jeux etc..),le projet MiageTchat qui est un tchat online like MSN public.

Avancement du projet

Fontionnalité	Back	Front	Test
Ressource
Ressource	Ganeistan	Inkaran
Accès
Connexion	Ganeistan	Inkaran
Inscription	Ganeistan	Inkaran
Compte
GetCompte	Ganeistan	Inkaran
UpdateCompte	Ganeistan	Inkaran
DeleteCompte	Ganeistan	Inkaran
Message
PostMessage	Ganeistan	Inkaran
GetMessage	Ganeistan	Inkaran
Acceuil
GetAllUsers	Ganeistan	Inkaran
GetUsersOnline	Ganeistan	Inkaran
À venir
…	Ganeistan	Inkaran

Contrat d’accès

Ressource

Ressource

• Return : http code + les méthodes format json
  • Url : hhttp://miagetchat.ovh:8080/MiageTchat/webapi/Ressource
  • Method : GET
  • Required :
  • Success Response :
    • Code : 200
    • Content : { “Function”: [ { “Lien”: “http://localhost:5000/MiageTchat/Connexion”, “Mot-cle”: “Connexion”, “Verbe” :”GET” }, { “Lien”: “http://localhost:5000/MiageTchat/Inscription”, “Mot-cle”: “Inscription”, “Verbe”:”POST” }, { “Lien”: “http://localhost:5000/MiageTchat/Compte”, “Mot-cle”: “GetCompte”, “Verbe”: “GET” } ] }
  • Error Response 1 :
    • Code : 400 BAD REQUEST
    • Content : Erreur

Accès

Connexion

• Return : un bearer token ou un http code erreur
• Url :http://miagetchat.ovh:8080/MiageTchat/webapi/Connexion
• Method : GET
• Required : UserId=[String] Password=[String]
• Success Response :
  • Code : 200
  • Content : Bearer Token MsgId=[Int]
• Error Response 1 :
  • Code : 404 NOT FOUND
  • Content : L'utilisateur n'existe pas
• Error Response 2 :
  • Code : 400 BAD REQUEST
  • Content : Mot de passe erroné

Déconnexion

• Return : un http code
• Url :http://miagetchat.ovh:8080/MiageTchat/webapi/Connexion/Off
• Method : GET
• Required : Bearer Token
• Success Response :
  • Code : 200
  • Content : Vous étes déconnecté
• Error Response 1 :
  • Code : 404 NOT FOUND
  • Content : L'utilisateur n'existe pas

Inscription

• Return : http code
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Inscription
• Method : POST
• Required : UserId=[String] First_Name=[String] Last_Name=[String] Birth_Year=[String] Gender=[String] Email=[String] Password=[String]
• Success Response :
  • Code : 200
  • Content : Félicitations, vous êtes bien inscrit
• Error Response 1 :
  • Code : 400 BAD REQUEST
  • Content : ID déja utilisé

Compte

GetCompte

• Return : http code + user data in json
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Compte
• Method : GET
• Required : Bearer Token
• Success Response :
  • Code : 200
  • Content : user
• Error Response 1 :
  • Code : 401 Unauthorized

UpdateCompte

• Return : http code + message
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Compte
• Method : PUT
• Required : Bearer Token UserId=[String] First_Name=[String] Last_Name=[String] Birth_date=[String] Gender=[String] Email=[String] Password=[String]
• Success Response :
  • Code : 200
  • Content : Compte mise à jour
• Error Response 1 :
  • Code : 401 Unauthorized

DeleteCompte

• Return : http code + liste des photos
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Compte
• Method : DELETE
• Required : Bearer Token UserId=[String]
• Success Response :
  • Code : 200
  • Content : Votre profil est bien supprimé
• Error Response 1 :
  • Code : 400 BAD REQUEST
  • Content : Aucune modification effectué

Message

PostMessage

• Description : Pour envoyer un message sur le fil public
• Return : http code
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Message
• Method : POST
• Required : Bearer Token Message=[String]
• Success Response :
  • Code : 200
  • Content : Votre message a été envoyer
• Error Response 1 :
  • Code : 400 BAD REQUEST
  • Content : Erreur

GetMessage

• Return : http code + message
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Message
• Method : GET
• Required : Bearer Token MsgId=[Int]
• Success Response :
  • Code : 200
  • Content :

  { “Messages”: [ { “UserId”: “Inkaran”, “Message”: “Salut”, “Date_Hour”:”27/06/06 21:36”, “MsgId”:”33” }, { “UserId”: “Ganeis”, “Message”: “Super”, “Date_Hour”:”27/06/06 21:37”, “MsgId”:”34” }, { “UserId”: “Inkaran”, “Message”: “Sava”, “Date_Hour”:”27/06/06 21:39”, “MsgId”:”35” } ] }

• Success Response :
  • Code : 201
  • Content : Pas de nouveau message
  • Error Response 1 :
    • Code : 400 BAD REQUEST
    • Content : Erreur

Acceuil

GetAllUsers

• Return : http code + tous users
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Utilisateurs
• Method : GET
• Required : Bearer Token
• Success Response :
  • Code : 200
  • Content : { “Users”: [ { “UserId”: “Inkaran”

    }, { “UserId”: “Ganeis”

    }, { “UserId”: “Kevin”

    } ] }

• Error Response 1 :
  • Code : 400 BAD REQUEST
  • Content : Erreur

GetUsersOnline

• Return : http code + tous users online
• Url : http://miagetchat.ovh:8080/MiageTchat/webapi/Utilisateurs/Online
• Method : GET
• Required : Bearer Token
• Success Response :
  • Code : 200
  • Content : { “Users”: [ { “UserId”: “Inkaran”

    }, { “UserId”: “Ganeis”

    }, { “UserId”: “Kevin”

    } ] }

• Error Response 1 :
  • Code : 400 BAD REQUEST
  • Content : Erreur