Invitations

Principe

Pour garder un contrôle sur les personnes ayant un accès au ressources de Matbay, nous passons par un système d'invitation qui sera le seul moyen de créer un compte sur le site. Pour cela, il faudra posséder un code d'invitation valide.

Module d'invitation

Une invitation contient :

• Un id qui sera utilisé pour avoir accès à l'invitation.
• L'utilisateur qui a créé cette invitation.
• La date de création.

Interface

interface Invite {
   id: string;
   createBy: string;
   date: string;
}

interface Inviter {
   displayName: string;
   photoURL: string;
}

interface NewAccount {
   uid: string;
   email: string;
   displayName: string;
   photoURL: string;
}

Requêtes WS

Event	Request parameters	Response	Subscribe Response	Description
INVITE-new				Créé une nouvelle invitation.
INVITE-delete	id: string			Supprime l'invitation spécifiée.
INVITE-get-all				Récupère la liste des invitations.
INVITE-update			status: "added" | "removed" | "modified" invite: Invite	Met à jours les données du client.
INVITE-unsubscribe				Supprime les mises à jours des invitations.

Requêtes HTTP

URL	HTTP verb	Body	Response	Description
/invite/:id	GET		isValid: boolean inviter: Inviter	Vérifie si l'invitation demandée est valide et si oui renvoie les informations de l'inviteur.
/invite/:id	POST	newAccount: NewAccount	response: ResponseStatus	Transmet les informations pour la création d'un nouveau compte. Le résultat de la création en renvoyé à l'utilisateur.