# Banners
# Obtener todos los banners
Para obtener el listado de todos los banners en Wasi, cuentas con la URI
:
api.wasi.co/v1/banner/search
Esto debería retornar un JSON
similar a este:
{
"1": {
"id_banner": 1,
"title": "Banner 1",
"link": "http://link.com/banner1",
"id_status": "1",
"status_label": "Active",
"image": "https://images.wasi.co/publicidad/banner1.jpg",
"position": 0
},
"2": {
"id_banner": 2,
"title": "Banner 2",
"link": "http://link.com/banner2",
"id_status": "2",
"status_label": "Inactive",
"image": "https://images.wasi.co/publicidad/banner2.jpg",
"position": 1
},
"3": {
"id_banner": 3,
"title": "Banner 3",
"link": "http://link.com/banner3",
"id_status": "1",
"status_label": "Active",
"image": "https://images.wasi.co/publicidad/banner3.jpg",
"position": 2
},
"total": 3,
"status": "success"
}
# Filtrado
Para filtrar aplican las siguientes opciones.
Filtro | Tipo | |
---|---|---|
query | String | Palabras claves para realizar una busqueda. |
id_status | Number | Id correspondiente al estado del banner, ver Campos de los banners. |
skip | Number | Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno). |
take | Number | Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo). |
# Obtener un banner
Para obtener un banner en Wasi, cuentas con la URI
:
api.wasi.co/v1/banner/get/#id_banner
Para un banner de ejemplo cuyo id_banner es 1, la URI
sería:
api.wasi.co/v1/banner/get/1
Esto debería retornar un JSON
similar a este:
{
"id_banner": 1,
"title": "Banner 1",
"link": "http://link.com/banner1",
"id_status": "1",
"status_label": "Active",
"image": "https://images.wasi.co/publicidad/bbanner1.jpg",
"position": 1,
"status": "success"
}
# Agregar un banner
Para agregar un nuevo banner en Wasi, cuentas con la URI
:
api.wasi.co/v1/banner/add
Para saber cuales son los parametros que se deben enviar se puede ver la sección Campos de los banners, los campos que podemos envíar como parámetro en la tabla deben figurar como modificables.
Despues de enviar los parametros correctamente debería devolver un JSON
como el siguiente:
{
"id_banner": 1,
"title": "Banner 1",
"link": "http://link.com/banner1",
"id_status": "1",
"status_label": "Active",
"image": "https://images.wasi.co/publicidad/bbanner1.jpg",
"position": 1,
"status": "success"
}
❗️ Importante
Los parametros pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
# Actualizar Banner
Para actualizar un banner en Wasi, cuentas con la URI
:
api.wasi.co/v1/banner/update/#id_banner
Para saber cuales son los campos que se pueden actualizar se puede ver la sección Campos de los banners, los campos que podemos envíar como parámetro en la tabla deben figurar como modificables.
Por ejemplo si se desea cambiar el titulo del banner id_banner 3, debe hacer lo siguiente:
api.wasi.co/v1/banner/update/3?title=Titulo test
Deberia devolver un JSON
como el siguiente:
{
"id_banner": 3,
"title": "Titulo test",
"link": "http://link.com/banner3",
"id_status": "1",
"status_label": "Active",
"image": "",
"position": 0
}
❗️ Importante
Los parametros a modificar pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
# Eliminar banner
Para eliminar un banner en Wasi, cuentas con la URI
:
api.wasi.co/v1/banner/delete/#id_banner
Por ejemplo si se desea eliminar el banner con id_banner 3, debe hacer lo siguiente:
api.wasi.co/v1/banner/delete/3
Deberia devolver un JSON
como el siguiente:
{
"id_banner": 3,
"status": "success"
}
❗️ Importante
La solicitud solo puede enviarse via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.