Members
(route) DELETE /products
Route:
| Method | Path |
|---|
| DELETE |
/products |
Elimina un producto
Authentication
Requiere token de autenticación y que el usuario sea admin
Route Parameters:
| Name |
Type |
Description |
| :productId |
String |
id del producto
|
Response:
| Name |
Type |
Description |
| product |
Object |
|
| product._id |
String |
Id |
| product.name |
String |
Nombre |
| product.price |
Number |
Precio |
| product.image |
URL |
URL a la imagen |
| product.type |
String |
Tipo/Categoría |
| product.dateEntry |
Date |
Fecha de creación |
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es ni admin |
| 404 |
si el producto con `productId` indicado no existe |
(route) GET /products
Route:
Lista productos
Authentication
Requiere token de autenticación
Header Parameters:
| Name |
Type |
Description |
| link |
Object |
Parámetros de paginación |
| link.first |
String |
Link a la primera página |
| link.prev |
String |
Link a la página anterior |
| link.next |
String |
Link a la página siguiente |
| link.last |
String |
Link a la última página |
Query Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| page |
String |
optional |
1 |
Página del listado a consultar |
| limit |
String |
optional |
10 |
Cantitad de elementos por página |
Response:
| Name |
Type |
Description |
| products |
Array |
|
| products[]._id |
String |
Id |
| products[].name |
String |
Nombre |
| products[].price |
Number |
Precio |
| products[].image |
URL |
URL a la imagen |
| products[].type |
String |
Tipo/Categoría |
| products[].dateEntry |
Date |
Fecha de creación |
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
(route) GET /products/:productId
Route:
| Method | Path |
|---|
| GET |
/products/:productId |
Obtiene los datos de un producto especifico
Authentication
Requiere token de autenticación
Route Parameters:
| Name |
Type |
Description |
| :productId |
String |
id del producto
|
Response:
| Name |
Type |
Description |
| product |
Object |
|
| product._id |
String |
Id |
| product.name |
String |
Nombre |
| product.price |
Number |
Precio |
| product.image |
URL |
URL a la imagen |
| product.type |
String |
Tipo/Categoría |
| product.dateEntry |
Date |
Fecha de creación |
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 401 |
si no hay cabecera de autenticación |
| 404 |
si el producto con `productId` indicado no existe |
(route) POST /products
Route:
| Method | Path |
|---|
| POST |
/products |
Crea un nuevo producto
Authentication
Requiere token de autenticación y que la usuaria sea admin
Body Parameters:
| Name |
Type |
Attributes |
Description |
| name |
String |
|
Nombre |
| price |
Number |
|
Precio |
| imagen |
String |
optional |
URL a la imagen |
| type |
String |
optional |
Tipo/Categoría |
Response:
| Name |
Type |
Description |
| product |
Object |
|
| products._id |
String |
Id |
| product.name |
String |
Nombre |
| product.price |
Number |
Precio |
| product.image |
URL |
URL a la imagen |
| product.type |
String |
Tipo/Categoría |
| product.dateEntry |
Date |
Fecha de creación |
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 400 |
si no se indican `name` o `price` |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es admin |
| 404 |
si el producto con `productId` indicado no existe |
(route) PUT /products
Route:
Modifica un producto
Authentication
Requiere token de autenticación y que el usuario sea admin
Body Parameters:
| Name |
Type |
Attributes |
Description |
| name |
String |
optional |
Nombre |
| price |
Number |
optional |
Precio |
| imagen |
String |
optional |
URL a la imagen |
| type |
String |
optional |
Tipo/Categoría |
Route Parameters:
| Name |
Type |
Description |
| :productId |
String |
id del producto
|
Response:
| Name |
Type |
Description |
| product |
Object |
|
| product._id |
String |
Id |
| product.name |
String |
Nombre |
| product.price |
Number |
Precio |
| product.image |
URL |
URL a la imagen |
| product.type |
String |
Tipo/Categoría |
| product.dateEntry |
Date |
Fecha de creación |
Response Code:
| Type |
Description |
| 200 |
si la autenticación es correcta |
| 400 |
si no se indican ninguna propiedad a modificar |
| 401 |
si no hay cabecera de autenticación |
| 403 |
si no es admin |
| 404 |
si el producto con `productId` indicado no existe |