{"id":444446,"date":"2026-04-03T02:43:16","date_gmt":"2026-04-03T00:43:16","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-gestion-de-archivos\/"},"modified":"2026-04-03T02:43:16","modified_gmt":"2026-04-03T00:43:16","password":"","slug":"api-rest-gestion-de-archivos","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-gestion-de-archivos\/","title":{"rendered":"API REST – Gesti\u00f3n de archivos"},"content":{"rendered":"

La subida de un archivo se realiza en varias etapas: crear un documento, subir el archivo y, a continuaci\u00f3n, vincularlos.<\/p>\n

\n

Paso 1: Obtener el ID de Webservice de la carpeta<\/h2>\n

Para crear un documento, necesita el identificador de Webservice de la carpeta de destino. Utilice una operaci\u00f3n query<\/code>: <\/p>\n

Ejemplo de curl:<\/strong><\/p>\n

curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=query&sessionName=YOUR_SESSION_ID&query=SELECT%20id%20FROM%20DocumentFolders%20WHERE%20foldername%20LIKE%20'Default'%20LIMIT%201%20;\"\n<\/code><\/pre>\n
Solicitud:<\/strong><\/p>\n
SELECT id FROM DocumentFolders WHERE foldername LIKE 'Default' LIMIT 1 ;\n<\/code><\/pre>\n
\n
Paso 2: Crear una entidad Documento<\/h2>\n
Cree una entidad de tipo Documents<\/code> mediante la operaci\u00f3n create<\/code>.<\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n
Par\u00e1metro<\/th>\nTipo<\/th>\nObligatorio<\/th>\nDescripci\u00f3n<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nDebe ser  create<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nIdentificador de sesi\u00f3n<\/td>\n<\/tr>\n
element<\/code><\/td>\nJSON<\/td>\ns\u00ed<\/td>\nObjeto JSON del documento (v\u00e9anse los campos a continuaci\u00f3n)<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nDebe ser  Documents<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Campos del objeto element<\/code>:<\/strong><\/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObligatorio<\/th>\nDescripci\u00f3n<\/th>\n<\/tr>\n<\/thead>\n
notes_title<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nNombre de la entidad documento<\/td>\n<\/tr>\n
folderid<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nID de Webservice de la carpeta (paso 1)<\/td>\n<\/tr>\n
filename<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nNombre del archivo<\/td>\n<\/tr>\n
filetype<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nTipo MIME (p. ej.: application\/pdf<\/code>)<\/td>\n<\/tr>\n
filesize<\/code><\/td>\nint<\/td>\ns\u00ed<\/td>\nTama\u00f1o del archivo en bytes<\/td>\n<\/tr>\n
filestatus<\/code><\/td>\nint<\/td>\ns\u00ed<\/td>\n1<\/code>  para activo<\/td>\n<\/tr>\n
filelocationtype<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nI<\/code>  para almacenamiento interno<\/td>\n<\/tr>\n
assigned_user_id<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nID de Webservice del usuario asignado<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Ejemplo de curl:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=create\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d 'element={\"notes_title\":\"Mon document\",\"folderid\":\"65x1\",\"filename\":\"rapport.pdf\",\"filetype\":\"application\/pdf\",\"filesize\":12345,\"filestatus\":1,\"filelocationtype\":\"I\",\"assigned_user_id\":\"19x1\"}' \\\n  -d \"elementType=Documents\"\n<\/code><\/pre>\n
\n
Paso 3: Subir el archivo (FileUpload)<\/h2>\n
Esta operaci\u00f3n sube el archivo y lo vincula al documento creado. Tambi\u00e9n puede utilizarse por s\u00ed sola para a\u00f1adir im\u00e1genes a los productos (sustituya attachmentType<\/code> por Image<\/code> y parentId<\/code> por el ID de Webservice del producto). <\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n\n\n
Par\u00e1metro<\/th>\nTipo<\/th>\nObligatorio<\/th>\nDescripci\u00f3n<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nDebe ser  FileUpload<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nIdentificador de sesi\u00f3n<\/td>\n<\/tr>\n
parentId<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nID de Webservice del documento (paso 2)<\/td>\n<\/tr>\n
attachmentType<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nAttachment<\/code>  para un archivo, Image<\/code> para una imagen<\/td>\n<\/tr>\n
fileName<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nNombre del archivo<\/td>\n<\/tr>\n
fileContents<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nContenido del archivo codificado en base64<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Ejemplo de curl:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=FileUpload\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d \"parentId=15x7890\" \\\n  -d \"attachmentType=Attachment\" \\\n  -d \"fileName=rapport.pdf\" \\\n  -d \"fileContents=$(base64 -w0 rapport.pdf)\"\n<\/code><\/pre>\n
\n
Recuperar un archivo (files_retrieve)<\/h2>\n
Recupera un archivo a\u00f1adido previamente a Kafinea. Necesita el WebserviceID del archivo<\/strong> (no confundir con el de la entidad Documento). <\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Par\u00e1metro<\/th>\nTipo<\/th>\nObligatorio<\/th>\nDescripci\u00f3n<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nDebe ser  files_retrieve<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nIdentificador de sesi\u00f3n<\/td>\n<\/tr>\n
id<\/code><\/td>\nstring<\/td>\ns\u00ed<\/td>\nID de Webservice del archivo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Ejemplo de curl:<\/strong><\/p>\n
curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=files_retrieve&sessionName=YOUR_SESSION_ID&id=28x5678\"\n<\/code><\/pre>\n
\n
Referencias asociadas \ud83d\udd17<\/h2>\n