Archivos API
Archivos contienen archivos digitales como imágenes o documentos usados en una tienda.
Objeto de Archivo
Atributo | Tipo | Descripción |
---|---|---|
id |
cadena | Identificador único del archivo. |
object |
cadena | El nombre del tipo de objeto. |
filename |
cadena | El nombre del archivo en el sistema. |
original_filename |
cadena | El nombre original del archivo al ser subido. |
src |
cadena | La ubicación del archivo. |
url |
cadena | La URL del archivo incluyendo el número de versión. |
mime_type |
cadena | El tipo MIME del archivo. |
size |
entero | El tamaño del archivo en bytes. |
created_at |
timestamp | Fecha de creación del archivo. |
updated_at |
timestamp | Última fecha de actualización del archivo. |
Listar los Archivos
GET /v1/files
{
"data": [
{
"id": "fil_cjeekovz20000lco2z6vwzu8c",
"object": "file",
"filename": "Lenna.png",
"original_filename": "Lenna.png",
"src": "/storage/store1/images/Lenna.png",
"url": "/storage/store1/images/Lenna.png?v=1520275350",
"mime_type": "image/png",
"size": 556219,
"created_at": 1520275350,
"updated_at": 1520275350
}
]
}
Parámetros
Nombre | Tipo | Default | Requerido | Descripción |
---|---|---|---|---|
page |
entero | 1 | false | Número de pagina a consultar. |
per_page |
entero | 50 | false | La cantidad de resultados a mostrar. |
Consultar un Archivo
GET /v1/files/{id}
{
"data": {
"id": "fil_cjeekovz20000lco2z6vwzu8c",
"object": "file",
"filename": "Lenna.png",
"original_filename": "Lenna.png",
"src": "/storage/store1/images/Lenna.png",
"url": "/storage/store1/images/Lenna.png?v=1520275350",
"mime_type": "image/png",
"size": 556219,
"created_at": 1520275350,
"updated_at": 1520275350
}
}
Parámetros
Ningúno.
Eliminar un Archivo
DELETE /v1/files/{id}
Parámetros
Ningúno.
Si es exitoso la respuesta será un HTTP 204 No Content
.