Descripción general
IMPORTANTE: Esta sección de la ayuda no es para usuarios, sino para técnicos y personal informático especializado en el desarrollo de aplicaciones.
El servicio de Consigna ofrece una API para posibilitar la integración con otras aplicaciones. Esta API permite realizar todas las mismas funciones de la interfaz web del servicio, mediante llamadas HTTP RESTful.
La API es accesible en la URL base: https://consigna.juntadeandalucia.es/api/v1/. Todos los recursos publicados para dicha API se encuentran disponibles a partir de esta URL base.
El listado de recursos publicados es el siguiente:
| Recurso | Función | URI | Descripción |
|---|---|---|---|
| Ficheros | GET | /api/v1/ficheros | Listado de ficheros del usuario |
| Ficheros | GET | /api/v1/ficheros/{fid} | Información sobre el fichero «fid» |
| Ficheros | POST | /api/v1/ficheros | Subida de un fichero |
| Ficheros | POST | /api/v1/ficheros/{fid} | Descarga del fichero «fid» con contraseña |
| Ficheros | PUT | /api/v1/ficheros/{fid} | Modificación del fichero «fid» |
| Ficheros | DELETE | /api/v1/ficheros/{fid} | Borrado del fichero «fid» |
| Enlace | POST | /api/v1/enlace/{fid} | Devuelve un enlace temporal para descargar el fichero «fid» protegido con contraseña |
| Enlace | GET | /api/v1/enlace/{tid} | Descarga de un fichero protegido con contraseña mediante un enlace activo temporalmente |
Listado de ficheros del usuario
Esta función permite obtener el listado de ficheros subidos por el usuario del cual se envían sus credenciales que continúan activos (no han caducado) en su cuenta de Consigna.
URI: /api/v1/ficheros
Tipo de petición: GET
Solicitud ejemplo:
curl -k -i -u username:password https://consigna.juntadeandalucia.es/api/v1/ficheros/ .
Salida ejemplo:
HTTP/1.1 200 OK
[
{
"fid": "03934d3f70b8f98d98363abb424a385c",
"nombre": "avatar.jpeg",
"tamBytes": "215",
"remitente": "uid=usuario1.prueba,o=sandetel,o=empleados,o=juntadeandalucia,c=es",
"uid": "usuario1.prueba",
"password": "false",
"fechaenvio": "10 de febrero de 2015, 16:15h",
"fechaexp": "10 de marzo de 2015, 16:15h",
"descripcion": "Imagen de avatar", "checksum":"665eb9192106315b51298f486ae8db235b6644cfc795030f44ab7b2e82c95f64", "contentType": "image\/png\n",
"estado": "LIMPIO",
"tam": "215 B"
}, {
"fid": "38147f106a72f970846a2d55c0237185",
"nombre": "facturas.xls",
"tamBytes": "9799",
"remitente": "uid=usuario2.prueba,o=sandetel,o=empleados,o=juntadeandalucia,c=es",
"uid": "usuario2.prueba",
"password": "true",
"fechaenvio": "06 de Mayo de 2015, 13:30h",
"fechaexp": "06 de Mayo de 2015, 13:30h",
"descripcion": "Facturas mes de Mayo", "checksum":"6bab836febddcaef5c610548bcc714df2e55556adaad8bd587968bac467c2d3a", "contentType": "application\/vnd.ms-excel\n",
"estado": "INFECTADO",
"tam": "9,57 KB"
},
]
Información de un fichero
Esta función permite obtener la información sobre un fichero subido a Consigna, conociendo su identificador «fid».
URI: /api/v1/ficheros/{fid}
Tipo de petición: GET
Parámetros:
- fid: (obligatorio) identificador del fichero.
Solicitud ejemplo:
curl -k -i -u username:password https://consigna.juntadeandalucia.es/api/v1/ficheros/03934d3f70b8f98d98363abb424a385c .
Salida ejemplo:
HTTP/1.1 200 OK
{
"fid": "03934d3f70b8f98d98363abb424a385c",
"nombre": "avatar.jpeg",
"tamBytes": "215",
"remitente": "uid=usuario1.prueba,o=sandetel,o=empleados,o=juntadeandalucia,c=es", "uid": "usuario1.prueba",
"password": "false",
"fechaenvio": "10 de febrero de 2015, 16:15h",
"fechaexp": "10 de marzo de 2015, 16:15h",
"descripcion": "Imagen de avatar", "checksum":"665eb9192106315b51298f486ae8db235b6644cfc795030f44ab7b2e82c95f64", "contentType": "image\/png\n",
"estado": "LIMPIO",
"tam": "215 B"
}
Subir un fichero
Esta función permite subir un nuevo fichero a Consigna, a la cuenta del usuario del cual se envían sus credenciales.
URI: /api/v1/ficheros
Tipo de petición: POST
Parámetros:
- fichero: (obligatorio) el fichero que se desea subir.
- expiracion: (opcional) tiempo de caducidad que se desea para el fichero. Solo se puede enviar uno de los siguientes valores permitidos:
- 1h : 1 hora
- 1d : 1 día
- 1sem : 1 semana
- 2sem : 2 semanas
- 1mes : 1 mes
- 3mes : 3 meses
- fichero_passwd: (opcional) contraseña para proteger la descarga del fichero.
- descripción: (opcional) descripción del fichero.
Solicitud ejemplo:
curl -k -i -u username:password -X POST -F «fichero=@/path/to/file» -F «expiracion=1mes» -F «description=textodescriptivo» https://consigna.juntadeandalucia.es/api/v1/ficheros .
Salida ejemplo:
HTTP/1.1 201 Created
Location: /api/v1/ficheros/01a72b0c7e550008b388c5b878d4f3ae
Descargar un fichero protegido por contraseña
Esta función permite descargar un fichero de Consigna que está protegido por contraseña.
URI: /api/v1/ficheros/{fid}
Tipo de petición: POST
Parámetros:
- fid: (obligatorio) identificador del fichero a descargar.
- fichero_passwd: (obligatorio) contraseña del fichero.
Solicitud ejemplo:
curl -k -i -u username:password -X POST -F «fichero_passwd=123456» https://consigna.juntadeandalucia.es/api/v1/ficheros/01a72b0c7e550008b388c5b878d4f3ae .
Salida ejemplo:
HTTP/1.1 200 OK
Modificar un fichero
Esta función permite modificar un fichero subido a Consigna por el usuario cuyas credenciales se envían. Se permiten modificar la contraseña y la descripción del fichero.
URI: /api/v1/ficheros/{fid}
Tipo de petición: PUT
Parámetros:
- fichero_passwd: (opcional) contraseña para proteger la descarga del fichero.
- descripción: (opcional) descripción del fichero.
Solicitud ejemplo:
curl -k -i -u username:password -X PUT -d descripcion=textodescriptivo -d fichero_passwd=123456 https://consigna.juntadeandalucia.es/api/v1/ficheros/01a72b0c7e550008b388c5b878d4f3ae .
Salida ejemplo:
HTTP/1.1 201 Created
Location: https://consigna.juntadeandalucia.es/api/v1/ficheros/01a72b0c7e550008b388c5b878d4f3ae
Borrar un fichero
Esta función permite borrar un fichero de Consigna, subido previamente por el usuario cuyas credenciales se envían.
URI: /api/v1/ficheros/{fid}
Tipo de petición: DELETE
Parámetros:
- fid: (obligatorio) identificador del fichero.
Solicitud ejemplo:
curl -k -i -u username:password -X DELETE https://consigna.juntadeandalucia.es/api/v1/ficheros/01a72b0c7e550008b388c5b878d4f3ae .
Salida ejemplo:
HTTP/1.1 204 No Content
Obtener un enlace temporal para descarga de fichero con contraseña
Esta función permite obtener un enlace temporal y de un solo uso que permite descargar un fichero protegido con contraseña sin tener que introducirla.
URI: /api/v1/enlace/{fid}
Tipo de petición: POST
Parámetros:
- fid: (obligatorio) identificador del fichero.
- fichero_passwd: (obligatorio) contraseña del fichero.
Solicitud ejemplo:
curl -k -i -u username:password -X POST -F ‘fichero_passwd=123456’ https://consigna.juntadeandalucia.es/api/v1/enlace/01a72b0c7e550008b388c5b878d4f3ae .
Salida ejemplo:
HTTP/1.1 200 OK
{
uri: /api/v1/enlace/25ac383915e60
}
Descargar un fichero con contraseña mediante enlace temporal
Esta función permite descargar un fichero protegido con contraseña sin tener que introducirla, utilizando un enlace temporal y de un solo uso generado previamente.
URI: /api/v1/enlace/{tid}
Tipo de petición: GET
Parámetros:
- tid: (obligatorio) identificador temporal del fichero para el enlace de descarga.
Solicitud ejemplo:
curl -k -i -u username:password https://consigna.juntadeandalucia.es/api/v1/enlace/25ac383915e60 .
Salida ejemplo:
HTTP/1.1 200 OK