{"id":444613,"date":"2026-07-27T00:41:34","date_gmt":"2026-07-26T22:41:34","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-documents-pdf\/"},"modified":"2026-07-27T01:30:35","modified_gmt":"2026-07-26T23:30:35","password":"","slug":"api-rest-documents-pdf","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-documents-pdf\/","title":{"rendered":"API REST – R\u00e9cup\u00e9rer le PDF d’un document"},"content":{"rendered":"

Cette page d\u00e9crit comment r\u00e9cup\u00e9rer, depuis une application tierce, le PDF d’un document commercial (facture, avoir, devis, commande, bon de livraison, bulletin de paie\u2026) exactement tel qu’il est g\u00e9n\u00e9r\u00e9 par Kafinea, avec le mod\u00e8le d’impression de votre choix.<\/p>\n

Par d\u00e9faut, lorsque le document est une facture<\/strong> ou un avoir<\/strong> et que les conditions sont r\u00e9unies, le PDF renvoy\u00e9 contient automatiquement le fichier Factur-X<\/strong> : aucun param\u00e8tre suppl\u00e9mentaire n’est n\u00e9cessaire (voir la section \u00ab Facture \u00e9lectronique \u00bb plus bas).<\/p>\n

Une seule op\u00e9ration est n\u00e9cessaire :<\/p>\n

\n\n\n\n\n\n
Op\u00e9ration<\/th>\nM\u00e9thode<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
mds_document_pdf<\/code><\/td>\nGET<\/td>\nR\u00e9cup\u00e9rer le PDF d’un document<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Elle n\u00e9cessite une session valide (voir Authentification<\/a>).<\/p>\n

\n

mds_document_pdf \u2013 R\u00e9cup\u00e9rer le PDF<\/h2>\n

G\u00e9n\u00e8re le PDF d’un enregistrement et le renvoie, soit encod\u00e9 en base64 dans la r\u00e9ponse JSON, soit directement sous forme de fichier PDF.<\/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\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 mds_document_pdf<\/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>\nIdentifiant Webservice de l’enregistrement (6x54325<\/code>), tel que renvoy\u00e9 par query<\/code> ou retrieve<\/code><\/td>\n<\/tr>\n
templateId<\/code><\/td>\nstring<\/td>\nnon<\/td>\nIdentifiant Webservice du mod\u00e8le d’impression (57x1088<\/code>). Si absent, le mod\u00e8le par d\u00e9faut du module est utilis\u00e9<\/td>\n<\/tr>\n
download<\/code><\/td>\nstring<\/td>\nnon<\/td>\n1<\/code> pour recevoir directement le fichier PDF au lieu de la r\u00e9ponse JSON<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Convention des identifiants :<\/strong> comme pour toutes les op\u00e9rations de l’API, id<\/code> et templateId<\/code> attendent l’identifiant Webservice complet<\/strong> (6x54325<\/code>), celui que renvoient query<\/code>, retrieve<\/code> ou describe<\/code>. Un identifiant brut (54325<\/code>) est refus\u00e9 avec le code INVALID_ID_ATTRIBUTE<\/code>.<\/p>\n<\/blockquote>\n

R\u00e9ponse JSON (par d\u00e9faut)<\/h3>\n
curl "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=mds_document_pdf&sessionName=YOUR_SESSION_ID&id=6x54325&templateId=57x1088"\n<\/code><\/pre>\n
{\n  "success": true,\n  "result": {\n    "id": "6x54325",\n    "module": "Invoice",\n    "templateId": "57x1088",\n    "filename": "Facture - 0053 - 2026-06-29.pdf",\n    "mime": "application\/pdf",\n    "size": 970618,\n    "base64": "JVBERi0xLjQKJeLjz9MK..."\n  }\n}\n<\/code><\/pre>\n
Le champ base64<\/code> contient les octets du PDF. D\u00e9codez-le pour reconstituer le fichier :<\/p>\n
$pdfBytes = base64_decode($response['result']['base64']);\nfile_put_contents($response['result']['filename'], $pdfBytes);\n<\/code><\/pre>\n
T\u00e9l\u00e9chargement direct du fichier<\/h3>\n
Avec download=1<\/code>, la r\u00e9ponse n’est plus du JSON : le fichier PDF est renvoy\u00e9 tel quel, avec les en-t\u00eates Content-Type: application\/pdf<\/code> et Content-Disposition: attachment<\/code>.<\/p>\n
curl -o facture.pdf "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=mds_document_pdf&sessionName=YOUR_SESSION_ID&id=6x54325&download=1"\n<\/code><\/pre>\n
\n
Astuce :<\/strong> Le mode download=1<\/code> \u00e9vite le surco\u00fbt de l’encodage base64 (environ +33 % de volume) : privil\u00e9giez-le lorsque vous archivez ou r\u00e9exp\u00e9diez le fichier tel quel.<\/p>\n<\/blockquote>\n
\n
Trouver l’identifiant d’un mod\u00e8le d’impression<\/h2>\n
Le param\u00e8tre templateId<\/code> est facultatif : sans lui, Kafinea utilise le mod\u00e8le par d\u00e9faut du module. Si vous souhaitez imposer un mod\u00e8le pr\u00e9cis, r\u00e9cup\u00e9rez son identifiant.<\/p>\n
\n
Rappel :<\/strong> Les mod\u00e8les d’impression sont un module Kafinea \u00e0 part enti\u00e8re, donc accessibles via les op\u00e9rations g\u00e9n\u00e9riques de l’API<\/strong> (describe<\/code>, query<\/code>, retrieve<\/code>\u2026). Aucune op\u00e9ration d\u00e9di\u00e9e n’est n\u00e9cessaire.<\/p>\n<\/blockquote>\n
curl --get "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php" \\\n  --data-urlencode "operation=query" \\\n  --data-urlencode "sessionName=YOUR_SESSION_ID" \\\n  --data-urlencode "query=SELECT id, templatename, basemodule, active FROM MdsPrintTemplate WHERE basemodule = 'Invoice';"\n<\/code><\/pre>\n
{\n  "success": true,\n  "result": [\n    { "id": "57x1088", "templatename": "Facture client", "basemodule": "Invoice", "active": "1" },\n    { "id": "57x1093", "templatename": "Facture d'avancement client", "basemodule": "Invoice", "active": "1" }\n  ]\n}\n<\/code><\/pre>\n
Le champ basemodule<\/code> indique le module auquel le mod\u00e8le s’applique. L’identifiant renvoy\u00e9 (57x1088<\/code>) s’utilise tel quel dans le param\u00e8tre templateId<\/code>.<\/p>\n
Un r\u00e9sultat vide signifie que le module ne dispose d’aucun mod\u00e8le d’impression : l’export PDF n’est alors pas possible pour ce module.<\/p>\n
\n
Modules concern\u00e9s<\/h2>\n
L’op\u00e9ration fonctionne pour tout module disposant d’au moins un mod\u00e8le d’impression<\/strong>, notamment :<\/p>\n