api-docs

Se puede ver aquí la documentación de la API desarrollada con Node.js, Express y la base de datos Mongo.DB. La API real no es de acceso público y se encuentra alojada en otro dominio, en este sitio solamente se puede consultar la documnetación. Esta API posee rutas para manejar la publicación, edición y eliminación de artículos y gráficos. Permite también almacenar y eliminar achivos de imagen y pdfs en un Bucket de AWS. Y posee todas las funcionalidades típicas para realizar una sesión de usuario con login, logout, reset-password, register, etc. La validación se realiza mediante Jason Web Token.

Artículos 5

Rutas relacionadas con la publicación, modificación y eliminación de archivos.

Description

Crear un nuevo artículo, título, contenido y autor son campos obligatorios.

Headers
KeyValueDescription
Content-Typeapplication/json
AuthorizationBearer {{token}}
Body
{
    "title": "el título del artículo",
    "content": "el contenido",
    "author": "el autor"
}
Description

Actualiza el contenido, título, etc, de un artículo

Headers
KeyValueDescription
Content-Typeapplication/json
URL Variables
KeyValueDescription
id
Body
{
    "content": "este es un cambio en el artículo"
}
Description

Borra artículo según el id y elimina la imagen del artículo del Bucket de AWS S3.

Headers
KeyValueDescription
Content-Typeapplication/json
URL Variables
KeyValueDescription
id
Description

Obtejer artículo mediante el id y el slug

Headers
KeyValueDescription
Content-Typeapplication/json
URL Variables
KeyValueDescription
id

Autenticación 5

Rutas relacionadas con autenticación de usario, passowrd, login, etc.

Description

Registrar un usuario con nombre, email, rol y contraseña.

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "name": "Nombre del usuario",
    "email": "xxx@xxxxx.com",
    "role": "por defecto el rol es usuario",
    "password": "minimo debe tener 8 caracteres"
}
Description

Login de usuario con email y password

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "email": "xxx@xxxx.com",
    "password": "xxxxxxxxx"
}
Description

Solicitar reseteo de contraseña

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "email": "xxx@xxxx.com"
}
Description

Resetea contraseña mediante url que se envió por mail al usuario.

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "password": "xxxxxxxx"
}
Description

Salir de sesión iniciada por el usuario y expira la cookie correspondiente.

Usuario 4

Description

Cambia la contraseña del usuario actualmente en sesión.

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "currentPassword": "xxxxxxx",
    "newPassword": "xxxxxxx"
}
Description

Actualiza nombre y mail del usuario.

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "name": "Juan Fulano",
    "email": "xxxx@xxxx.com"
}
Description

Elimina usuario actualmente loggeado de la base de datos.

Headers
KeyValueDescription
Content-Typeapplication/json

Canastas 8

Canasta básica de los jubilados, funciones para ver, crear, actualizar y borrar canastas. Y cargar y descargar archivos PDF en el Bucket de AWS S3.

Description

Aquí se puede publicar una nueva canasta cargando toda la información correspondiente en cada item.

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "número": "27",
    "período": "Octubre-2022",
    "canasta": "151438",
    "mínima": "43000",
    "categorías": {
        "vivienda": "49374",
        "transporte": "8000",
        "vestimenta": "9700",
        "recreación": "5960",
        "servicios": "10670",
        "alimentos": "29912",
        "limpieza": "12849",
        "medicamentos": "25013"
    }
}
Description

Ver todas las Canastas publicadas hasta el momento

URL Variables
KeyValueDescription
id
Description

Actualiza canasta publicada según el id de la misma

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "período": "Abril del 900"
}
Description

Eliminar canasta según el id y elimina el PDF del Bukcet de AWS S3.

Description

Obtener información de una canasta específica según el ID.

URL Variables
KeyValueDescription
id
Description

Descarga PDF con información de la Canasta.

URL Variables
KeyValueDescription
id
Description

Carga imagen en el Bucket de AWS S3.