{"id":445367,"date":"2026-11-15T01:26:26","date_gmt":"2026-11-15T00:26:26","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-reference-complete\/"},"modified":"2026-11-15T01:26:26","modified_gmt":"2026-11-15T00:26:26","password":"","slug":"api-rest-reference-complete","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/","title":{"rendered":"API REST &#8211; R\u00e9f\u00e9rence compl\u00e8te (OpenAPI)"},"content":{"rendered":"<p>Toutes les op\u00e9rations de l&rsquo;API Kafinea sont d\u00e9crites dans une r\u00e9f\u00e9rence unique : param\u00e8tres, types,<br \/>\nvaleurs accept\u00e9es, droits n\u00e9cessaires et exemples de r\u00e9ponse. Elle existe sous deux formes, tenues \u00e0<br \/>\njour \u00e0 chaque \u00e9volution de l&rsquo;API.<\/p>\n<hr \/>\n<h2>Pour un d\u00e9veloppeur : la r\u00e9f\u00e9rence interactive<\/h2>\n<p><strong><a href=\"https:\/\/www.kafinea.com\/fr\/reference-api\/\">Ouvrir la r\u00e9f\u00e9rence de l&rsquo;API<\/a><\/strong><\/p>\n<p>Les op\u00e9rations y sont class\u00e9es par domaine (enregistrements, requ\u00eates, documents, comptabilit\u00e9,<br \/>\nparam\u00e9trage\u2026), avec une recherche. Chaque op\u00e9ration affiche :<\/p>\n<ul>\n<li>sa m\u00e9thode HTTP et ses param\u00e8tres, obligatoires ou facultatifs ;<\/li>\n<li>un exemple d&rsquo;appel pr\u00eat \u00e0 copier, en <code>curl<\/code> et dans les principaux langages (PHP, Python,<br \/>\nJavaScript, Java, C#\u2026) ;<\/li>\n<li>un exemple de r\u00e9ponse ;<\/li>\n<li>le badge <strong>Administrateur<\/strong> lorsqu&rsquo;elle est r\u00e9serv\u00e9e aux administrateurs de l&rsquo;instance.<\/li>\n<\/ul>\n<p>Choisissez le nom de votre instance dans le champ <strong>Serveur<\/strong> : les exemples d&rsquo;appel l&rsquo;utilisent<br \/>\ndirectement.<\/p>\n<hr \/>\n<h2>Pour vos outils et vos agents IA : la sp\u00e9cification OpenAPI<\/h2>\n<p><strong>Adresse stable de la sp\u00e9cification :<\/strong> <code>https:\/\/www.kafinea.com\/fr\/api\/openapi.json<\/code><\/p>\n<p>Ce fichier suit la norme <strong>OpenAPI 3.1<\/strong>, lue par la plupart des outils du march\u00e9 :<\/p>\n<ul>\n<li><strong>g\u00e9n\u00e9rateurs de clients<\/strong> : produisez une biblioth\u00e8que cliente typ\u00e9e dans votre langage ;<\/li>\n<li><strong>clients HTTP et outils de test<\/strong> : importez le fichier pour obtenir une collection de requ\u00eates<br \/>\npr\u00eate \u00e0 l&#8217;emploi ;<\/li>\n<li><strong>agents IA<\/strong> : donnez cette adresse \u00e0 votre agent, il y trouve chaque op\u00e9ration, ses param\u00e8tres<br \/>\net leurs r\u00e8gles.<\/li>\n<\/ul>\n<p>L&rsquo;adresse ne change pas : elle m\u00e8ne toujours \u00e0 la derni\u00e8re version publi\u00e9e.<\/p>\n<hr \/>\n<h2>Lire la sp\u00e9cification<\/h2>\n<p>L&rsquo;API passe par un point d&rsquo;entr\u00e9e unique, <code>webservice.php<\/code>. Chaque op\u00e9ration y est d\u00e9crite avec un<br \/>\nchemin de la forme <code>\/webservice.php?operation=&lt;nom&gt;<\/code>, qui est aussi l&rsquo;URL r\u00e9ellement appel\u00e9e.<\/p>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>\u00c9l\u00e9ment<\/th>\n<th>O\u00f9 le trouver dans la sp\u00e9cification<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Session<\/td>\n<td>Le sch\u00e9ma de s\u00e9curit\u00e9 <code>session<\/code> : param\u00e8tre <code>sessionName<\/code>, obtenu avec <code>login<\/code><\/td>\n<\/tr>\n<tr>\n<td>Param\u00e8tres d&rsquo;une op\u00e9ration GET<\/td>\n<td>Dans l&rsquo;URL (<code>in: query<\/code>)<\/td>\n<\/tr>\n<tr>\n<td>Param\u00e8tres d&rsquo;une op\u00e9ration POST<\/td>\n<td>Dans le corps du formulaire (<code>application\/x-www-form-urlencoded<\/code>)<\/td>\n<\/tr>\n<tr>\n<td>Param\u00e8tre de type objet ou liste<\/td>\n<td>Envoy\u00e9 sous forme de texte JSON (<code>contentMediaType: application\/json<\/code>) ; sa structure est dans <code>contentSchema<\/code><\/td>\n<\/tr>\n<tr>\n<td>R\u00e9serv\u00e9e aux administrateurs<\/td>\n<td>Extension <code>x-kafinea-access: admin<\/code><\/td>\n<\/tr>\n<tr>\n<td>Op\u00e9ration de lecture ou d&rsquo;\u00e9criture<\/td>\n<td>Extension <code>x-kafinea-scope<\/code> : <code>read<\/code>, <code>write<\/code> ou <code>configure<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<p>Les champs des modules d\u00e9pendent du param\u00e9trage de chaque instance (champs personnalis\u00e9s, champs<br \/>\nactiv\u00e9s) : la sp\u00e9cification d\u00e9crit les op\u00e9rations, et <code>describe<\/code> renvoie les champs exacts de votre<br \/>\ninstance.<\/p>\n<hr \/>\n<h2>R\u00e9f\u00e9rences associ\u00e9es \ud83d\udd17<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/\">Introduction \u00e0 l&rsquo;API<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-authentification\/\">Authentification<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-requetes-et-interrogation\/\">Requ\u00eates et interrogation<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-import-en-masse\/\">Import en masse (upsert)<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Toutes les op\u00e9rations de l&rsquo;API Kafinea sont d\u00e9crites dans une r\u00e9f\u00e9rence unique : param\u00e8tres, types, valeurs accept\u00e9es, droits n\u00e9cessaires et exemples de r\u00e9ponse. Elle existe sous deux formes, tenues \u00e0 jour \u00e0 chaque \u00e9volution de l&rsquo;API. Pour un d\u00e9veloppeur : la r\u00e9f\u00e9rence interactive Ouvrir la r\u00e9f\u00e9rence de l&rsquo;API Les op\u00e9rations y sont class\u00e9es par domaine&#8230;<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"","ping_status":"closed","template":"","meta":{"_uag_custom_page_level_css":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","footnotes":""},"doc_category":[58],"doc_tag":[],"class_list":["post-445367","docs","type-docs","status-publish","hentry","doc_category-api"],"year_month":"2026-11","word_count":428,"total_views":"3","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"name":"David Valminos","author_nicename":"david","author_url":"https:\/\/www.kafinea.com\/fr\/author\/david\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/"}],"doc_tag_info":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea\" \/>\n<meta property=\"og:description\" content=\"Toutes les op\u00e9rations de l&rsquo;API Kafinea sont d\u00e9crites dans une r\u00e9f\u00e9rence unique : param\u00e8tres, types, valeurs accept\u00e9es, droits n\u00e9cessaires et exemples de r\u00e9ponse. Elle existe sous deux formes, tenues \u00e0 jour \u00e0 chaque \u00e9volution de l&rsquo;API. Pour un d\u00e9veloppeur : la r\u00e9f\u00e9rence interactive Ouvrir la r\u00e9f\u00e9rence de l&rsquo;API Les op\u00e9rations y sont class\u00e9es par domaine...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/\" \/>\n<meta property=\"og:site_name\" content=\"Kafinea\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-reference-complete\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-reference-complete\\\/\",\"name\":\"Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#website\"},\"datePublished\":\"2026-11-15T00:26:26+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-reference-complete\\\/#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-reference-complete\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-reference-complete\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API REST &#8211; R\u00e9f\u00e9rence compl\u00e8te (OpenAPI)\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#website\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/\",\"name\":\"Kafinea\",\"description\":\"Une solution unique pour toutes vos ambitions\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"fr-FR\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#organization\",\"name\":\"Kafinea\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/wp-content\\\/uploads\\\/2024\\\/10\\\/Logo-Kafinea-SVG-orange-bleu.svg\",\"contentUrl\":\"https:\\\/\\\/www.kafinea.com\\\/wp-content\\\/uploads\\\/2024\\\/10\\\/Logo-Kafinea-SVG-orange-bleu.svg\",\"width\":296.31,\"height\":66.48,\"caption\":\"Kafinea\"},\"image\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/kafinea\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/","og_locale":"fr_FR","og_type":"article","og_title":"Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea","og_description":"Toutes les op\u00e9rations de l&rsquo;API Kafinea sont d\u00e9crites dans une r\u00e9f\u00e9rence unique : param\u00e8tres, types, valeurs accept\u00e9es, droits n\u00e9cessaires et exemples de r\u00e9ponse. Elle existe sous deux formes, tenues \u00e0 jour \u00e0 chaque \u00e9volution de l&rsquo;API. Pour un d\u00e9veloppeur : la r\u00e9f\u00e9rence interactive Ouvrir la r\u00e9f\u00e9rence de l&rsquo;API Les op\u00e9rations y sont class\u00e9es par domaine...","og_url":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/","og_site_name":"Kafinea","twitter_card":"summary_large_image","twitter_misc":{"Dur\u00e9e de lecture estim\u00e9e":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/","url":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/","name":"Documentation - API REST - R\u00e9f\u00e9rence compl\u00e8te (OpenAPI) &#8226; Kafinea","isPartOf":{"@id":"https:\/\/www.kafinea.com\/fr\/#website"},"datePublished":"2026-11-15T00:26:26+00:00","breadcrumb":{"@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-reference-complete\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.kafinea.com\/fr\/"},{"@type":"ListItem","position":2,"name":"API REST &#8211; R\u00e9f\u00e9rence compl\u00e8te (OpenAPI)"}]},{"@type":"WebSite","@id":"https:\/\/www.kafinea.com\/fr\/#website","url":"https:\/\/www.kafinea.com\/fr\/","name":"Kafinea","description":"Une solution unique pour toutes vos ambitions","publisher":{"@id":"https:\/\/www.kafinea.com\/fr\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.kafinea.com\/fr\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"fr-FR"},{"@type":"Organization","@id":"https:\/\/www.kafinea.com\/fr\/#organization","name":"Kafinea","url":"https:\/\/www.kafinea.com\/fr\/","logo":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/www.kafinea.com\/fr\/#\/schema\/logo\/image\/","url":"https:\/\/www.kafinea.com\/wp-content\/uploads\/2024\/10\/Logo-Kafinea-SVG-orange-bleu.svg","contentUrl":"https:\/\/www.kafinea.com\/wp-content\/uploads\/2024\/10\/Logo-Kafinea-SVG-orange-bleu.svg","width":296.31,"height":66.48,"caption":"Kafinea"},"image":{"@id":"https:\/\/www.kafinea.com\/fr\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/kafinea\/"]}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"David Valminos","author_link":"https:\/\/www.kafinea.com\/fr\/author\/david\/"},"uagb_comment_info":0,"uagb_excerpt":"Toutes les op\u00e9rations de l&rsquo;API Kafinea sont d\u00e9crites dans une r\u00e9f\u00e9rence unique : param\u00e8tres, types, valeurs accept\u00e9es, droits n\u00e9cessaires et exemples de r\u00e9ponse. Elle existe sous deux formes, tenues \u00e0 jour \u00e0 chaque \u00e9volution de l&rsquo;API. Pour un d\u00e9veloppeur : la r\u00e9f\u00e9rence interactive Ouvrir la r\u00e9f\u00e9rence de l&rsquo;API Les op\u00e9rations y sont class\u00e9es par domaine...","_links":{"self":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs\/445367","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/comments?post=445367"}],"version-history":[{"count":0,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs\/445367\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/media?parent=445367"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/doc_category?post=445367"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/doc_tag?post=445367"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}