03 Especificación API Pública

Especificación

La siguiente especificación incluye la ruta, el método, las cabeceras y el cuerpo que espera cada uno de los endpoints públicos del sistema.

Método	Endpoint	Cabeceras	Cuerpo	Respuesta Correcta	Error	Descripción
POST	/api/auth/tokens		{username: <username>, password:<password>}	CREATED + Token	UNAUTHORIZED	Valida las credenciales y genera un token de acceso.
GET	/api/users?filters	token:<youtToken>		OK + Users		Busca entre los usuarios aplicando los filtros.
POST	/api/users		{Userdata...}	CREATED + User	CONFLICT	Crea un nuevo usuario.
GET	/api/users/{id}	token:<youtToken>		OK + User	NOT_FOUND, UNAUTHORIZED	Devuelve un usuario concreto.
PUT	/api/users/{id}	token:<youtToken>	{Userdata...}	OK + User	NOT_FOUND, UNAUTHORIZED	Modifica un usuario.
DELETE	/api/v1/users/{id}	token:<youtToken>		OK	NOT_FOUND, UNAUTHORIZED	Elimina un usuario.
GET	/api/chats	token:<youtToken>		OK + Your Chats		Devuelve todos los chats de un usuario.
GET	/api/chats/{id}	token:<youtToken>		OK + Chat	UNAUTHORIZED, NOT_FOUND	Devuleve un chat en concreto.
POST	/api/chats/{id}	token:<youtToken>	{otherUserId:<id>}	CREATED + Chat	UNAUTHORIZED, CONFLICT	Crea un mensaje al chat entre dos usuarios.
DELETE	/api/chats/{id}	PUT	Token	Message	200, 404	Añade un mensaje al chat entre dos usuarios. Si el chat no existe lo crea.
GET	/api/chats/{id}/messages	token:<youtToken>		OK Messages	UNAUTHORIZED, NOT_FOUND	Devuleve los mensjes de chat en concreto
POST	/api/chats/{id}/messages	token:<youtToken>	{message...}	CREATED + Message	UNAUTHORIZED, NOT_FOUND	Crea un mensaje en un chat.
GET	/api/v1/statistics	token:<youtToken>		200 Statistics	404	Devuelve todas las estadísticas del ecosistema.
GET	/api/v1/users/{id}/statistics	token:<youtToken>		200 Statistics	404	Devuelve las estadísticas de un usuario.
POST	/api/translations	token:<youtToken>	{text:text,from-lang:lang,to-lang:lang}	201 Translation	404	Devuelve la tradución para un texto dado.