khush2706 / Finance-Buddy-Backend

Routes

Parent Routes

For Registration of Parent

POST request on the URL - https://finance-buddy-backend.vercel.app/parent/register.

Request HEADER should include -

{
    "Content-Type": "application/json"
}

Request body should include -

{
    name: "Shubham Gautam",
    email: "[e-mail]",
    password: "userPassword"
}

Response is a JS object that looks like this -

{
    id: 6219f59b29849955414a7c5e
}

For Login of Parent

POST request on the URL - https://finance-buddy-backend.vercel.app/parent/login.

Request HEADER should include -

{
    "Content-Type": "application/json"
}

Request body should include -

{
    email: "[e-mail]",
    password: "userPassword"
}

Response is a JS object that looks like this -

{
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2h1YmhhbSIsImVtYWlsIjoic2cyMTk5MjAzQGdtYWlsLmNvbSIsImNoaWxkcmVuIjpbXSwic2VudFJlcXVlc3RzIjpbXSwiaWQiOiI2MjE5ZjU5YjI5ODQ5OTU1NDE0YTdjNWUiLCJpYXQiOjE2NDU4NzI4MzZ9.tYuKEw1ZFh2GWlV_uZYF17PTDzG1Usil7humKBCXx1M"
    }
}

For Dashboard of Parent

GET request on the URL - https://finance-buddy-backend.vercel.app/parent/dashboard.

Request HEADER should include -

{
    "Content-Type": "application/json",
    "auth-token" <token_recieved_during_login_request>
}

Response is a JS object that looks like this -

{
    "error": null,
    "data": {
        "parent": {
            "name": "shubham",
            "email": "[e-mail]",
            "children": [],
            "sentRequests": [],
            "id": "6219f59b29849955414a7c5e",
            "iat": 1645868906
        }
    }
}

Child Routes

For Registration of child

POST request on the URL - https://finance-buddy-backend.vercel.app/child/register.

Request HEADER should include -

{
    "Content-Type": "application/json"
}

Request body should include -

{
    name: "Shubham Gautam",
    email: "[e-mail]",
    password: "userPassword"
}

Response is a JS object that looks like this -

{
    id: 6219f59b29849955414a7c5e
}

For Login of Child

POST request on the URL - https://finance-buddy-backend.vercel.app/child/login.

Request HEADER should include -

{
    "Content-Type": "application/json"
}

Request body should include -

{
    email: "[e-mail]",
    password: "userPassword"
}

Response is a JS object that looks like this -

{
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2h1YmhhbSIsImVtYWlsIjoic2cyMTk5MjAzQGdtYWlsLmNvbSIsImNoaWxkcmVuIjpbXSwic2VudFJlcXVlc3RzIjpbXSwiaWQiOiI2MjE5ZjU5YjI5ODQ5OTU1NDE0YTdjNWUiLCJpYXQiOjE2NDU4NzI4MzZ9.tYuKEw1ZFh2GWlV_uZYF17PTDzG1Usil7humKBCXx1M"
    }
}

For Dashboard of Child

GET request on the URL - https://finance-buddy-backend.vercel.app/child/dashboard.

Request HEADER should include -

{
    "Content-Type": "application/json",
    "auth-token" <token_recieved_during_login_request>
}

Response is a JS object that looks like this -

{
    "error": null,
    "data": {
        "parent": {
            "name": "shubham",
            "email": "[e-mail]",
            "parent": [],
            "recievedRequests": [],
            "id": "6219f59b29849955414a7c5e",
            "iat": 1645868906
        }
    }
}

Quiz Routes

To get a quiz on topic, make a GET request on this URL https://finance-buddy-backend.vercel.app/quiz?topic=sip

In place of SIP we can use -

1. sip
2. mutualFunds
3. nft
4. crypto

Lessons Routes

To get a quiz on topic, make a GET request on this URL https://finance-buddy-backend.vercel.app/lesson?topic=sip

In place of SIP we can use -

1. sip
2. mutualFunds
3. nft
4. crypto

Assign Quiz

To assign a quiz from PARENTS' dashboard, make a POST request to https://finance-buddy-backend.vercel.app/quiz/assign. Body of POST request should look like this -

{
    parentEmail: "[e-mail]",
    childEmail: "[e-mail]",
    quizTopic: "sip",
}

You will recieve -

{
    error: null
}

Assign Lesson

To assign a lesson from PARENTS' dashboard, make a POST request to https://finance-buddy-backend.vercel.app/lesson/assign. Body of POST request should look like this -

{
    parentEmail: "[e-mail]",
    childEmail: "[e-mail]",
    lessonTopic: "sip",
}

You will recieve -

{
    error: null
}

Complete quiz

To mark a quiz as complete and save it in history, make a POST request to https://finance-buddy-backend.vercel.app/quiz/complete. The body should include -

{
    parentEmail: "[e-mail]",
    childEmail: "[e-mail]",
    quizTopic: "sip",
    quizScore: 5
}

Complete Lesson

To mark a quiz as complete and save it in history, make a POST request to https://finance-buddy-backend.vercel.app/lesson/complete. The body should include -

{
    parentEmail: "[e-mail]",
    childEmail: "[e-mail]",
    lessonTopic: "sip",
}