{"id":441540,"date":"2026-04-03T02:43:16","date_gmt":"2026-04-03T00:43:16","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-fichiers\/"},"modified":"2026-04-23T01:47:38","modified_gmt":"2026-04-22T23:47:38","password":"","slug":"api-rest-fichiers","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-fichiers\/","title":{"rendered":"API REST – Gestion des fichiers"},"content":{"rendered":"

Le t\u00e9l\u00e9chargement d’un fichier se fait en plusieurs \u00e9tapes : cr\u00e9er un document, uploader le fichier, puis les lier.<\/p>\n

\n

\u00c9tape 1 : Obtenir l’ID Webservice du dossier<\/h2>\n

Pour cr\u00e9er un document, vous avez besoin de l’identifiant Webservice du dossier cible. Utilisez une op\u00e9ration query<\/code> :<\/p>\n

Exemple 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
Requ\u00eate :<\/strong><\/p>\n
SELECT id FROM DocumentFolders WHERE foldername LIKE 'Default' LIMIT 1 ;\n<\/code><\/pre>\n
\n
\u00c9tape 2 : Cr\u00e9er une entit\u00e9 Document<\/h2>\n
Cr\u00e9ez une entit\u00e9 de type Documents<\/code> via l’op\u00e9ration 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
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre create<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
element<\/code><\/td>\nJSON<\/td>\noui<\/td>\nObjet JSON du document (voir champs ci-dessous)<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre Documents<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Champs de l’objet element<\/code> :<\/strong><\/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Champ<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
notes_title<\/code><\/td>\nstring<\/td>\noui<\/td>\nNom de l’entit\u00e9 document<\/td>\n<\/tr>\n
folderid<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice du dossier (\u00e9tape 1)<\/td>\n<\/tr>\n
filename<\/code><\/td>\nstring<\/td>\noui<\/td>\nNom du fichier<\/td>\n<\/tr>\n
filetype<\/code><\/td>\nstring<\/td>\noui<\/td>\nType MIME (ex : application\/pdf<\/code>)<\/td>\n<\/tr>\n
filesize<\/code><\/td>\nint<\/td>\noui<\/td>\nTaille du fichier en octets<\/td>\n<\/tr>\n
filestatus<\/code><\/td>\nint<\/td>\noui<\/td>\n1<\/code> pour actif<\/td>\n<\/tr>\n
filelocationtype<\/code><\/td>\nstring<\/td>\noui<\/td>\nI<\/code> pour stockage interne<\/td>\n<\/tr>\n
assigned_user_id<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice de l’utilisateur assign\u00e9<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple 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
\u00c9tape 3 : Uploader le fichier (FileUpload)<\/h2>\n
Cette op\u00e9ration uploade le fichier et le lie au document cr\u00e9\u00e9. Elle peut aussi \u00eatre utilis\u00e9e seule pour ajouter des images aux produits (remplacez attachmentType<\/code> par Image<\/code> et parentId<\/code> par l’ID Webservice du produit).<\/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
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre FileUpload<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
parentId<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice du document (\u00e9tape 2)<\/td>\n<\/tr>\n
attachmentType<\/code><\/td>\nstring<\/td>\noui<\/td>\nAttachment<\/code> pour un fichier, Image<\/code> pour une image<\/td>\n<\/tr>\n
fileName<\/code><\/td>\nstring<\/td>\noui<\/td>\nNom du fichier<\/td>\n<\/tr>\n
fileContents<\/code><\/td>\nstring<\/td>\noui<\/td>\nContenu du fichier encod\u00e9 en base64<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple 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
R\u00e9cup\u00e9rer un fichier (files_retrieve)<\/h2>\n
R\u00e9cup\u00e8re un fichier pr\u00e9c\u00e9demment ajout\u00e9 \u00e0 Kafinea. Vous avez besoin du WebserviceID du fichier<\/strong> (\u00e0 ne pas confondre avec celui de l’entit\u00e9 Document).<\/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
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre files_retrieve<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
id<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice du fichier<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple 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
R\u00e9f\u00e9rences associ\u00e9es \ud83d\udd17<\/h2>\n