/API

Primary LanguageJava

AdvisorApp - API Build Status

Contributing

In order to contribute, you must follow the guidelines described in Contributing And update the CHANGELOG on each tickets you close

Architecture

The architecture followed these pictures :

On server

Architecture

On Model

Architecture

Authentication & Authorisation

We chose to use JWT for authentication.

SignUp

To SignUp you have to do this request :

POST http://localhost:8090/api/auths/signup

Json body :
{
    "firstName": "firstName",
    "lastName": "lastName",
    "birthday": 1464294633131,
    "remoteId": 1234569,
    "email": "example@example.com",
    "password": "superSt0ngPassword"
}

It should return a 200 on success.

SignIn

Once you signed-up, you will have to get a token (JWT). In order to to that, you have to do this request :

POST http://localhost:8090/api/auths/token

Json body :
{
    "email": "example@example.com",
    "password": "superSt0ngPassword"
}

It should return :

{
  "token": "json.web.token"
}

Then for each request you will do, you will have to attach the token in header. For instance :

GET http://localhost:8090/api/auths/hello

Header :
X-Authorization -> json.web.token