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: "sg2199203@gmail.com",
password: "userPassword"
}
Response is a JS object that looks like this -
{
id: 6219f59b29849955414a7c5e
}
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: "sg2199203@gmail.com",
password: "userPassword"
}
Response is a JS object that looks like this -
{
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2h1YmhhbSIsImVtYWlsIjoic2cyMTk5MjAzQGdtYWlsLmNvbSIsImNoaWxkcmVuIjpbXSwic2VudFJlcXVlc3RzIjpbXSwiaWQiOiI2MjE5ZjU5YjI5ODQ5OTU1NDE0YTdjNWUiLCJpYXQiOjE2NDU4NzI4MzZ9.tYuKEw1ZFh2GWlV_uZYF17PTDzG1Usil7humKBCXx1M"
}
}
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": "sg2199203@gmail.com",
"children": [],
"sentRequests": [],
"id": "6219f59b29849955414a7c5e",
"iat": 1645868906
}
}
}
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: "sg2199203@gmail.com",
password: "userPassword"
}
Response is a JS object that looks like this -
{
id: 6219f59b29849955414a7c5e
}
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: "sg2199203@gmail.com",
password: "userPassword"
}
Response is a JS object that looks like this -
{
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2h1YmhhbSIsImVtYWlsIjoic2cyMTk5MjAzQGdtYWlsLmNvbSIsImNoaWxkcmVuIjpbXSwic2VudFJlcXVlc3RzIjpbXSwiaWQiOiI2MjE5ZjU5YjI5ODQ5OTU1NDE0YTdjNWUiLCJpYXQiOjE2NDU4NzI4MzZ9.tYuKEw1ZFh2GWlV_uZYF17PTDzG1Usil7humKBCXx1M"
}
}
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": "sg2199203@gmail.com",
"parent": [],
"recievedRequests": [],
"id": "6219f59b29849955414a7c5e",
"iat": 1645868906
}
}
}
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 -
- sip
- mutualFunds
- nft
- crypto
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 -
- sip
- mutualFunds
- nft
- crypto
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: "sg2199203@gmail.com",
childEmail: "kc223013@gmail.com",
quizTopic: "sip",
}
You will recieve -
{
error: null
}
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: "sg2199203@gmail.com",
childEmail: "kc223013@gmail.com",
lessonTopic: "sip",
}
You will recieve -
{
error: null
}
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: "sg2199203@gmail.com",
childEmail: "kc223013@gmail.com",
quizTopic: "sip",
quizScore: 5
}
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: "sg2199203@gmail.com",
childEmail: "kc223013@gmail.com",
lessonTopic: "sip",
}