{"id":441525,"date":"2026-04-02T23:39:26","date_gmt":"2026-04-02T21:39:26","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-introduction\/"},"modified":"2026-04-23T01:47:48","modified_gmt":"2026-04-22T23:47:48","password":"","slug":"api-rest-introduction","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/","title":{"rendered":"API REST &#8211; Introduction"},"content":{"rendered":"<p>Profitez des API REST expos\u00e9es sur HTTP(s) pour pousser ou tirer des donn\u00e9es de Kafinea et les int\u00e9grer \u00e0 des applications tierces. Vous \u00eates libre de choisir la biblioth\u00e8que de votre choix pour travailler avec ces API.<\/p>\n<hr \/>\n<h2>Principes g\u00e9n\u00e9raux<\/h2>\n<p>L&rsquo;API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque requ\u00eate est unique et ind\u00e9pendante. Rien n&rsquo;est stock\u00e9 en cache.<\/p>\n<ul>\n<li><strong>Protocole :<\/strong> HTTP(s)<\/li>\n<li><strong>M\u00e9thodes :<\/strong> GET et POST<\/li>\n<li><strong>Format de r\u00e9ponse :<\/strong> JSON<\/li>\n<li><strong>URL de base :<\/strong> <code>https:\/\/apps.kafinea.com\/{VotreInstance}\/webservice.php<\/code><\/li>\n<\/ul>\n<hr \/>\n<h2>Format des r\u00e9ponses<\/h2>\n<h3>R\u00e9ponse positive<\/h3>\n<pre><code class=\"language-json\">{\n  &quot;success&quot;: true,\n  &quot;result&quot;: {\n    \/\/ ...\n  }\n}\n<\/code><\/pre>\n<h3>R\u00e9ponse n\u00e9gative<\/h3>\n<pre><code class=\"language-json\">{\n  &quot;success&quot;: false,\n  &quot;error&quot;: {\n    &quot;message&quot;: &quot;[STRING]&quot;,\n    &quot;code&quot;: &quot;[STRING]&quot;\n  }\n}\n<\/code><\/pre>\n<hr \/>\n<h2>R\u00e9capitulatif des op\u00e9rations<\/h2>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Op\u00e9ration<\/th>\n<th>M\u00e9thode<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>getchallenge<\/code><\/td>\n<td>GET<\/td>\n<td>Obtenir un token de connexion<\/td>\n<\/tr>\n<tr>\n<td><code>login<\/code><\/td>\n<td>POST<\/td>\n<td>Se connecter<\/td>\n<\/tr>\n<tr>\n<td><code>logout<\/code><\/td>\n<td>POST<\/td>\n<td>Se d\u00e9connecter<\/td>\n<\/tr>\n<tr>\n<td><code>extendsession<\/code><\/td>\n<td>GET<\/td>\n<td>Prolonger la session<\/td>\n<\/tr>\n<tr>\n<td><code>listtypes<\/code><\/td>\n<td>GET<\/td>\n<td>Lister les modules disponibles<\/td>\n<\/tr>\n<tr>\n<td><code>describe<\/code><\/td>\n<td>GET<\/td>\n<td>D\u00e9crire les champs d&rsquo;un module<\/td>\n<\/tr>\n<tr>\n<td><code>create<\/code><\/td>\n<td>POST<\/td>\n<td>Cr\u00e9er une entit\u00e9<\/td>\n<\/tr>\n<tr>\n<td><code>retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>R\u00e9cup\u00e9rer une entit\u00e9<\/td>\n<\/tr>\n<tr>\n<td><code>update<\/code><\/td>\n<td>POST<\/td>\n<td>Mettre \u00e0 jour une entit\u00e9<\/td>\n<\/tr>\n<tr>\n<td><code>delete<\/code><\/td>\n<td>POST<\/td>\n<td>Supprimer une entit\u00e9<\/td>\n<\/tr>\n<tr>\n<td><code>query<\/code><\/td>\n<td>GET<\/td>\n<td>Interroger la base de donn\u00e9es<\/td>\n<\/tr>\n<tr>\n<td><code>query_related<\/code><\/td>\n<td>GET<\/td>\n<td>Interroger les listes connexes<\/td>\n<\/tr>\n<tr>\n<td><code>add_related<\/code><\/td>\n<td>POST<\/td>\n<td>Ajouter une relation entre entit\u00e9s<\/td>\n<\/tr>\n<tr>\n<td><code>getPicklistValues<\/code><\/td>\n<td>GET<\/td>\n<td>R\u00e9cup\u00e9rer les valeurs d&rsquo;une liste d\u00e9roulante<\/td>\n<\/tr>\n<tr>\n<td><code>setPicklistValues<\/code><\/td>\n<td>POST<\/td>\n<td>Modifier les valeurs d&rsquo;une liste d\u00e9roulante<\/td>\n<\/tr>\n<tr>\n<td><code>FileUpload<\/code><\/td>\n<td>POST<\/td>\n<td>T\u00e9l\u00e9charger un fichier<\/td>\n<\/tr>\n<tr>\n<td><code>files_retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>R\u00e9cup\u00e9rer un fichier<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<hr \/>\n<h2>R\u00e9f\u00e9rences associ\u00e9es \ud83d\udd17<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.kafinea.com\/documentation\/api\/api-rest-authentification\/\">Authentification<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/documentation\/api\/api-rest-operations-crud\/\">Op\u00e9rations CRUD<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/documentation\/api\/api-rest-operations-liees\/\">Op\u00e9rations li\u00e9es<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/documentation\/api\/api-rest-requetes-et-interrogation\/\">Requ\u00eates et interrogation<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Profitez des API REST expos\u00e9es sur HTTP(s) pour pousser ou tirer des donn\u00e9es de Kafinea et les int\u00e9grer \u00e0 des applications tierces. Vous \u00eates libre de choisir la biblioth\u00e8que de votre choix pour travailler avec ces API. Principes g\u00e9n\u00e9raux L&rsquo;API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque&#8230;<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"closed","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-441525","docs","type-docs","status-publish","hentry","doc_category-api"],"year_month":"2026-06","word_count":277,"total_views":0,"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 v27.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Documentation - API REST - Introduction &#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-introduction\/\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documentation - API REST - Introduction &#8226; Kafinea\" \/>\n<meta property=\"og:description\" content=\"Profitez des API REST expos\u00e9es sur HTTP(s) pour pousser ou tirer des donn\u00e9es de Kafinea et les int\u00e9grer \u00e0 des applications tierces. Vous \u00eates libre de choisir la biblioth\u00e8que de votre choix pour travailler avec ces API. Principes g\u00e9n\u00e9raux L&rsquo;API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/\" \/>\n<meta property=\"og:site_name\" content=\"Kafinea\" \/>\n<meta property=\"article:modified_time\" content=\"2026-04-22T23:47:48+00:00\" \/>\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=\"1 minute\" \/>\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-introduction\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-introduction\\\/\",\"name\":\"Documentation - API REST - Introduction &#8226; Kafinea\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/#website\"},\"datePublished\":\"2026-04-02T21:39:26+00:00\",\"dateModified\":\"2026-04-22T23:47:48+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-introduction\\\/#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-introduction\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/api\\\/api-rest-introduction\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/fr\\\/documentation\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API REST &#8211; Introduction\"}]},{\"@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 - Introduction &#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-introduction\/","og_locale":"fr_FR","og_type":"article","og_title":"Documentation - API REST - Introduction &#8226; Kafinea","og_description":"Profitez des API REST expos\u00e9es sur HTTP(s) pour pousser ou tirer des donn\u00e9es de Kafinea et les int\u00e9grer \u00e0 des applications tierces. Vous \u00eates libre de choisir la biblioth\u00e8que de votre choix pour travailler avec ces API. Principes g\u00e9n\u00e9raux L&rsquo;API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque...","og_url":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/","og_site_name":"Kafinea","article_modified_time":"2026-04-22T23:47:48+00:00","twitter_card":"summary_large_image","twitter_misc":{"Dur\u00e9e de lecture estim\u00e9e":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/","url":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/","name":"Documentation - API REST - Introduction &#8226; Kafinea","isPartOf":{"@id":"https:\/\/www.kafinea.com\/fr\/#website"},"datePublished":"2026-04-02T21:39:26+00:00","dateModified":"2026-04-22T23:47:48+00:00","breadcrumb":{"@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-introduction\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.kafinea.com\/fr\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/www.kafinea.com\/fr\/documentation\/"},{"@type":"ListItem","position":3,"name":"API REST &#8211; Introduction"}]},{"@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":"Profitez des API REST expos\u00e9es sur HTTP(s) pour pousser ou tirer des donn\u00e9es de Kafinea et les int\u00e9grer \u00e0 des applications tierces. Vous \u00eates libre de choisir la biblioth\u00e8que de votre choix pour travailler avec ces API. Principes g\u00e9n\u00e9raux L&rsquo;API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque...","_links":{"self":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs\/441525","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=441525"}],"version-history":[{"count":14,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs\/441525\/revisions"}],"predecessor-version":[{"id":442953,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/docs\/441525\/revisions\/442953"}],"wp:attachment":[{"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/media?parent=441525"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/doc_category?post=441525"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.kafinea.com\/fr\/wp-json\/wp\/v2\/doc_tag?post=441525"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}