Docs

Docs

Docs of Triviator!

Frontend backend communication docs

POST /v1/register

Request:

{
'email': <email>,
'date': <date> 
}

Response:

{
'status' : <status_code>,
}

POST /v1/verify

Request:

{
'code': <code>,
'email': <code>
}

Response:

{
'Games': [
{
'name': <game_name>,
'avatar': <avatar_b64encoded>
},
{
'name': <game_name>,
'avatar': <avatar_b64encoded>
},
...
],
'User': {
'name': 'user_name',
'email': 'user_email'
}
}

POST /v1/new

Request:

{
'name': <game_name>,
'avatar': <avatar_b64encoded>,
'Questions': [
{
'number': <q_no>,
'question': <question>,
'options': {
'1': <option_1>,
'2': <option_2>,
'3': <option_3>,
'4': <option_4>,
},
'correct': <correct_no>
},
{
'number': <q_no>,
'question': <question>,
'options': {
'1': <option_1>,
'2': <option_2>,
'3': <option_3>,
'4': <option_4>,
},
'correct': <correct_no>
},
{
'number': <q_no>,
'question': <question>,
'options': {
'1': <option_1>,
'2': <option_2>,
'3': <option_3>,
'4': <option_4>,
},
'correct': <correct_no>
},
...
]
}

Response:

{
'status': <status_code>,
'game_pin': <game_pin>
}

POST /v1/existing

Request:

{
'name': <game_name>,
'email': <user_email>
}

Response:

{
'code': <game_code>,
'status': <status_code>,
}

POST /v1/start

Request:

{
'User': {
'name': <user_name>,
'email': <email>
},
code: <game_code>,
'state': <state>
}

Response:

{
'Players': [
{
'name': <player_name>,
'avatar': <b64_encoded>
},
{
'name': <player_name>,
'avatar': <b64_encoded>
},
{
'name': <player_name>,
'avatar': <b64_encoded>
}
]
}

POST /v1/join

Request:

{
'code': <game_code>,
'User': {
'name': <player_name>,
'avatar': <b64_encoded>
},
}

Response:

{
'Players': [
{
'name': <player_name>,
'avatar': <b64_encoded>
},{
'name': <player_name>,
'avatar': <b64_encoded>
},
{
'name': <player_name>,
'avatar': <b64_encoded>
},
...
]
}

Incomplete