{"id":444427,"date":"2026-04-02T23:39:26","date_gmt":"2026-04-02T21:39:26","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-introduction\/"},"modified":"2026-04-02T23:39:26","modified_gmt":"2026-04-02T21:39:26","password":"","slug":"rest-api-introduction","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/","title":{"rendered":"REST API &#8211; Introduction"},"content":{"rendered":"<p>Take advantage of REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose the library of your choice to work with these APIs. <\/p>\n<hr>\n<h2>General Principles<\/h2>\n<p>The Kafinea API is a REST API: you communicate directly with your Kafinea instance and each request is unique and independent. Nothing is cached. <\/p>\n<ul>\n<li><strong>Protocol:<\/strong> HTTP(s)<\/li>\n<li><strong>Methods:<\/strong> GET and POST<\/li>\n<li><strong>Response format:<\/strong> JSON<\/li>\n<li><strong>Base URL:<\/strong> <code>https:\/\/apps.kafinea.com\/{VotreInstance}\/webservice.php<\/code><\/li>\n<\/ul>\n<hr>\n<h2>Response Format<\/h2>\n<h3>Positive Response<\/h3>\n<pre><code class=\"language-json\">{\n  \"success\": true,\n  \"result\": {\n    \/\/ ...\n  }\n}\n<\/code><\/pre>\n<h3>Negative Response<\/h3>\n<pre><code class=\"language-json\">{\n  \"success\": false,\n  \"error\": {\n    \"message\": \"[STRING]\",\n    \"code\": \"[STRING]\"\n  }\n}\n<\/code><\/pre>\n<hr>\n<h2>Operations Summary<\/h2>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Operation<\/th>\n<th>Method<\/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>Get a connection token<\/td>\n<\/tr>\n<tr>\n<td><code>login<\/code><\/td>\n<td>POST<\/td>\n<td>Log in<\/td>\n<\/tr>\n<tr>\n<td><code>logout<\/code><\/td>\n<td>POST<\/td>\n<td>Log out<\/td>\n<\/tr>\n<tr>\n<td><code>extendsession<\/code><\/td>\n<td>GET<\/td>\n<td>Extend the session<\/td>\n<\/tr>\n<tr>\n<td><code>listtypes<\/code><\/td>\n<td>GET<\/td>\n<td>List available modules<\/td>\n<\/tr>\n<tr>\n<td><code>describe<\/code><\/td>\n<td>GET<\/td>\n<td>Describe the fields of a module<\/td>\n<\/tr>\n<tr>\n<td><code>create<\/code><\/td>\n<td>POST<\/td>\n<td>Create an entity<\/td>\n<\/tr>\n<tr>\n<td><code>retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>Retrieve an entity<\/td>\n<\/tr>\n<tr>\n<td><code>update<\/code><\/td>\n<td>POST<\/td>\n<td>Update an entity<\/td>\n<\/tr>\n<tr>\n<td><code>delete<\/code><\/td>\n<td>POST<\/td>\n<td>Delete an entity<\/td>\n<\/tr>\n<tr>\n<td><code>query<\/code><\/td>\n<td>GET<\/td>\n<td>Query the database<\/td>\n<\/tr>\n<tr>\n<td><code>query_related<\/code><\/td>\n<td>GET<\/td>\n<td>Query related lists<\/td>\n<\/tr>\n<tr>\n<td><code>add_related<\/code><\/td>\n<td>POST<\/td>\n<td>Add a relationship between entities<\/td>\n<\/tr>\n<tr>\n<td><code>getPicklistValues<\/code><\/td>\n<td>GET<\/td>\n<td>Retrieve the values of a dropdown list<\/td>\n<\/tr>\n<tr>\n<td><code>setPicklistValues<\/code><\/td>\n<td>POST<\/td>\n<td>Modify the values of a dropdown list<\/td>\n<\/tr>\n<tr>\n<td><code>FileUpload<\/code><\/td>\n<td>POST<\/td>\n<td>Upload a file<\/td>\n<\/tr>\n<tr>\n<td><code>files_retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>Retrieve a file<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<hr>\n<h2>Related References \ud83d\udd17<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-authentication\/\">Authentication<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-crud-operations\/\">CRUD Operations<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-entity-relationships\/\">Related Operations<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/en\/documentation\/api\/rest-api-requests-and-querying\/\">Requests and Queries<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Take advantage of REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose the library of your choice to work with these APIs. General Principles The Kafinea API is a REST API: you communicate directly with your Kafinea instance and each request&#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":[759],"doc_tag":[],"class_list":["post-444427","docs","type-docs","status-publish","hentry","doc_category-api"],"year_month":"2026-08","word_count":213,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"David Valminos","author_nicename":"david","author_url":"https:\/\/www.kafinea.com\/en\/author\/david\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/www.kafinea.com\/en\/help\/api\/"}],"doc_tag_info":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.1 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Help - REST API - 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\/en\/help\/api\/rest-api-introduction\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Help - REST API - Introduction &#8226; Kafinea\" \/>\n<meta property=\"og:description\" content=\"Take advantage of REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose the library of your choice to work with these APIs. General Principles The Kafinea API is a REST API: you communicate directly with your Kafinea instance and each request...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/\" \/>\n<meta property=\"og:site_name\" content=\"Kafinea\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\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\\\/en\\\/help\\\/api\\\/rest-api-introduction\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-introduction\\\/\",\"name\":\"Help - REST API - Introduction &#8226; Kafinea\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#website\"},\"datePublished\":\"2026-04-02T21:39:26+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-introduction\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-introduction\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/help\\\/api\\\/rest-api-introduction\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API &#8211; Introduction\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\",\"name\":\"Kafinea\",\"description\":\"Une solution unique pour toutes vos ambitions\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#organization\",\"name\":\"Kafinea\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/en\\\/#\\\/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\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/kafinea\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Help - REST API - 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\/en\/help\/api\/rest-api-introduction\/","og_locale":"en_US","og_type":"article","og_title":"Help - REST API - Introduction &#8226; Kafinea","og_description":"Take advantage of REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose the library of your choice to work with these APIs. General Principles The Kafinea API is a REST API: you communicate directly with your Kafinea instance and each request...","og_url":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/","og_site_name":"Kafinea","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/","url":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/","name":"Help - REST API - Introduction &#8226; Kafinea","isPartOf":{"@id":"https:\/\/www.kafinea.com\/en\/#website"},"datePublished":"2026-04-02T21:39:26+00:00","breadcrumb":{"@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-introduction\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.kafinea.com\/en\/"},{"@type":"ListItem","position":2,"name":"REST API &#8211; Introduction"}]},{"@type":"WebSite","@id":"https:\/\/www.kafinea.com\/en\/#website","url":"https:\/\/www.kafinea.com\/en\/","name":"Kafinea","description":"Une solution unique pour toutes vos ambitions","publisher":{"@id":"https:\/\/www.kafinea.com\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.kafinea.com\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.kafinea.com\/en\/#organization","name":"Kafinea","url":"https:\/\/www.kafinea.com\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.kafinea.com\/en\/#\/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\/en\/#\/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\/en\/author\/david\/"},"uagb_comment_info":0,"uagb_excerpt":"Take advantage of REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose the library of your choice to work with these APIs. General Principles The Kafinea API is a REST API: you communicate directly with your Kafinea instance and each request...","_links":{"self":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs\/444427","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/comments?post=444427"}],"version-history":[{"count":0,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/docs\/444427\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/media?parent=444427"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/doc_category?post=444427"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.kafinea.com\/en\/wp-json\/wp\/v2\/doc_tag?post=444427"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}