• API

  • Authentification
  • Routes

• Websockets

  • Type 'user'
  • Type 'lobby'
  • Type 'game'

• Requests

  • Types de requêtes
  • Format de la requête
    1. Envoyer la requête
    2. Recevoir la réponse

• Workflow

  • Se connecter à sa socket
  • Rejoindre un Lobby
  • Créer une Game
  • Rejoindre une Game
  • Quitter une game
  • Quitter un Lobby

• Codes de retour des Sockets

  • Succès
  • Erreurs globales
  • Erreurs liées au Lobby
  • Erreurs liées au User
  • Erreurs liées a une Game

Accepts :

• application/x-www-form-urlencoded
• application/json

Remote test server : https://morbak.alan-balbo.com

• Login with /api/auth/login
• This should respond with something like :

{
    "user": {
        "_id": "5ad0b5f26568137c6c85e228",
        "username": "MonBlaze",
        "creationDate": "2018-04-13T14:07:13.052Z",
        "__v": 0
    },
    "token": "MY_TOKEN"
}

• You should save the user somewhere, as well as the token
• Again, the token should be saved in local storage for auto login
• The token must be provided in the Authorization header of every request to the API, preceded with the Bearer keyword; like so:

Authorization: Bearer MY_TOKEN

Reçues uniquement après l'envoi d'une requête

Elle te push les événements suivants :

• Mise à jour du profil
• Tu as rejoins une room
• Tu as quitté une room
• Tu as été kick d'une room
• Tu as créé une room
• Tu as rejoins une game
• Tu as terminé une game
• Tu as reçu une réponse à une requête

Reçues uniquement si le user est dans un lobby

Push les événements suivants :

• Un joueur a rejoint le lobby
• Un joueur a quitté le lobby
• Un joueur en a invité un autre à jouer
• Un joueur a accepté une invitation
• Une partie vient de commencer
• Une partie vient de se terminer
• Une partie ouverte vient d'être créée (peut être rejointe par n'importe qui)
• Le lobby vient d'être créé
• Le lobby vient d'être détruit

Reçues uniquement si le user est dans une game

• La game vient d'être créée
• Un joueur a rejoint la game
• Un joueur a quitté la game
• Un spectateur a rejoint la partie
• Un spectateur est parti
• Un joueur vient de jouer un coup
• La partie est terminée
• Une nouvelle partie vient d'être lancée
• La game a été détruite

joinLobby : Le user veut rejoindre un lobby

joinGame : Le user veut rejoindre une game

invitePlayer : Le user veut inviter un autre user à jouer

createGame: Le user veut créer une partie ouverte

Fair un appel sur POST /request avec le body suivant :

{
  type: 'joinLobby' | 'joinGame' | 'invitePlayer' | 'createGame',
  accessResource: "ResourceId"
}

Le call renvoie la request créée (avec son id)

Dans la websocket de ton user tu vas recevoir la réponse à la Request quand elle sera traitée (y'a une queue côté serveur)

• Soit elle a un status: 'rejected' et du coup tu peux afficher un message d'erreur comme quoi la requête associé à fail
• Soit elle a un status: 'ok' et tu peux interpréter le message

Une reponse ressemble à ça :

{
  request: Request // La request associée,
  message: '', // Un message explicite sur la response
  statusCode: 0, // Le code de retour normalisé de la response
  status: 'rejected' | 'ok' | 'aborted', // Le statut clair de la response
  resourceLink: '', // Un lien vers la resource associée
  time: 23165465132132, // timestamp 
  type: 'user' | 'lobby' | 'game'
}

(je documenterai les codes de retour sur le fil)

En gros, si dans tes sockets tu reçois une requête de type 'joinLobby' avec le statut 'ok', ça veut dire que tu as rejoins un lobby. Donc si tu fais

• GET /lobbies/{LobbyId}/members Tu vas voir que tu es dans la liste des users du lobby, et quand tu feras le get, ça va te renvoyer un lien vers la websocket du lobby

• Se connecter au serveur de websocket:  ws://${serverURL}
• Envoyer un message sur le serveur de websocket avec le contenu suivant :

{
  "userId": "idDuUser"
}

Le serveur répond ok quand vous êtes connectés à la socket.

Avant de pouvoir jouer, il faut rejoindre un lobby

1. Envoyer une requête pour rejoindre le lobby:

POST /api/requests

2. Attendre la réponse sur sa socket. Les sockets envoient la réponse suivante :

{
  requestId: '5adcb45580876a5beecb9440',
  message: 'Lobby joined',
  statusCode: 101,
  status: 'ok',
  resourceURI: '/api/lobbies/5adcb42580876a5beecb943f',
  time: 123454654161,
  type: 'user'
}

Avant de pouvoir jouer, il faut créer une game

1. Envoyer une requête pour créer la game:

POST /api/requests

2. Attendre la réponse sur sa socket. Les sockets envoient la réponse suivante :

{
  requestId: '5adcb45580876a5beecb9440',
  message: 'Game created',
  statusCode: 301,
  status: 'ok',
  resourceURI: '/api/games/5adcb42580876a5beecb943f',
  time: 123454654161,
  type: 'user'
}

Avant de pouvoir jouer, il faut rejoindre une game

1. Envoyer une requête pour créer la game:

POST /api/requests

2. Attendre la réponse sur sa socket. Les sockets envoient la réponse suivante :

{
  requestId: '5adcb45580876a5beecb9440',
  message: 'Game joined',
  statusCode: 302,
  status: 'ok',
  resourceURI: '/api/games/5adcb42580876a5beecb943f',
  time: 123454654161,
  type: 'user'
}

Il suffit de mettre à jour son profil user avec 'game': undefined pour quitter la game.

PUT /api/users/{id}

Il suffit de mettre à jour son profil user avec 'lobby': undefined pour quitter la game.

PUT /api/users/{id}