Skip to content
ErikTamano edited this page May 14, 2024 · 2 revisions

L'API està creada en NodeJS fent ús d'Express i ws per a control·lar les trucades POST i les connexions de WebSockets.

Trucades de l'API:

URL PARÀMETRES RESPOSTA DESCRIPCIÓ
/login email:String
password:String
{
status: "OK" || "KO",
result: String,
token?: String
}
Inicia sessió i retorna el token de sessió de l'usuari. Si la contrasenya o el nom d'usuari no són correctes, retorna l'error corresponent en comptes del token.
/register email:String
username:String
password:String
{
status: "OK" || "KO",
result: String,
token?: String
}
Es registra un nou usuari i retorna el seu token de sessió. Si l'usuari ja existeix, retorna un missatge d'error.
/googleLogin email:String
name:String
{
status: "OK" || "KO",
result: String,
token?: String
}
Inicia sessió (o es registra si l'usuari mai s'ha logejat) després a partir del widget de Login amb comptes de Google.
/getProjects token:String {
status: "OK" || "KO",
result: Array || String
}
Rep un token de sessió i retorna tots els projectes disponibles per a l'usuari amb aquest token. Si no es troba cap usuari, retorna un missatge de error.
/getUser token:String {
status: "OK" || "KO",
result: Object || String
}
Rep un token de sessió i retorna les dades de l'usuari amb aquest token. Si no es troba cap usuari, retorna un missatge de error.
/getProject token:String
projectID:String
{
status: "OK" || "KO",
result: Object || String
}
Rep un token de sessió i un ID de projecte i retorna les dades del projecte corresponent. Si el token no correspon a cap usuari o no existeix cap projecte amb l'ID donat, retorna un missatge d'error corresponent.
/createProject token:String
title:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió i un títol, crea un projecte amb aquest títol i l'usuari corresponent al token com a creador, i retorna l'ID del projecte creat. Si el token no correspon a cap usuari o l'usuari ja ha creat un projecte amb el mateix nom, retorna el missatge d'error corresponent.
/createSprintBoard token:String
projectID:String
newName:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte i un nom i crea un Sprint al projecte donat amb el nom donat. Retorna OK i un missatge de confirmació si es realitza l'invitació correctament o un missatge d'error corresponent si el token no pertany a cap usuari, no existeix cap projecte amb l'ID donat o ja existeix un Sprint al projecte amb aquest nom.
/getSprintBoards token:String
projectID:String
{
status: "OK" || "KO",
result: Array || String
}
Rep un token de sessió i un ID de projecte i retorna les dades de tots els Sprints que conté el projecte donat. Retorna un missatg d'error si no es troba cap usuari amb aquest token o no es troba cap projecte amb aquest ID.
/editSprintBoard token:String
projectID:String
oldName:String
newName:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte, el nom d'un Sprint i el nou nom d'aquest i actualitza el Sprint corresponent. Retorna un missatge de error corresponent si el nou nom està en ús en el mateix projecte, no es troba cap usuari amb el token donat o no es troba cap projecte amb l'ID donat.
/deleteSprintBoard token:String
projectID:String
name:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte i un nom de Sprint i borra el Sprint corresponent del projecte. Retorna OK si s'ha realitzat correctament o un missatge d'error si no es troba cap usuari amb el token donat o no es troba cap projecte amb l'ID donat.
/createTask token:String
projectID:String
sprintName
name:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte, el nom d'un Sprint i el nom d'una tasca i crea la tasca corresponent. Retorna OK si s'ha realitzat correctament o un missatge
/getTasksInSprint token:String
projectID:String
sprintName:String
{
status: "OK" || "KO",
result: Array || String
}
Rep un token de sessió, un ID de projecte i el nom d'un Sprint i retorna totes les tasques del Sprint donat. Retorna un missatge d'error si no es troba cap usuari amb el token donat, no es troba cap projecte amb l'ID donat o no es troba cap Sprint amb el nom donat en el projecte.
/getTasksInProject token:String
projectID:String
{
status: "OK" || "KO",
result: Array || String
}
Rep un token de sessió i un ID de projecte i retorna totes les tasques del projecte donat. Retorna un missatge d'error si no es troba cap usuari amb el token donat o no es troba cap projecte amb l'ID donat.
/editTask token:String
projectID:String
sprintName:String
oldName:String
newName?:String
status?:String
description?:String
assignedMember?:String
estimatedDuration?:Int
estimatedStartDate?:DateTime
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte, un nom de Sprint el nom de la tasca a canviar i les noves dades i actualitza la tasca corresponent. Retorna OK si s'ha realitzat correctament o un missatge d'error si no es troba cap usuari amb el token donat, no es troba cap projecte amb l'ID donat, no es troba el Sprint o no es troba la tasca donada.
/deleteTask token:String
projectID:String
sprintName:String
taskName:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte, un nom de Sprint i un nom de tasca i elimina la tasca corresponent. Retorna OK si s'ha realitzat correctament o un missatge d'error si no es troba cap usuari amb el token donat, no es troba cap projecte amb l'ID donat, no es troba el Sprint o no es troba la tasca donada.
/sendInviteEmail token:String
projectID:String
email:String
{
status: "OK" || "KO",
result: String
}
Rep un token de sessió, un ID de projecte i un email i envia una invitació a colaborar en el projecte per correu electrònic a l'adreça indicada. Retorna OK i un missatge de confirmació si es realitza l'invitació correctament o un missatge d'error corresponent si el token no pertany a cap usuari o no existeix cap projecte amb l'ID donat.

Clone this wiki locally