{"id":444453,"date":"2026-04-02T23:39:26","date_gmt":"2026-04-02T21:39:26","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-introduccion\/"},"modified":"2026-04-02T23:39:26","modified_gmt":"2026-04-02T21:39:26","password":"","slug":"api-rest-introduccion","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/","title":{"rendered":"API REST &#8211; Introducci\u00f3n"},"content":{"rendered":"<p>Aproveche las API REST expuestas en HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Es libre de elegir la biblioteca que prefiera para trabajar con estas API. <\/p>\n<hr>\n<h2>Principios generales<\/h2>\n<p>La API de Kafinea es una API REST: usted se comunica directamente con su instancia de Kafinea y cada petici\u00f3n es \u00fanica e independiente. No se almacena nada en la cach\u00e9. <\/p>\n<ul>\n<li><strong>Protocolo:<\/strong> HTTP(s)<\/li>\n<li><strong>M\u00e9todos:<\/strong> GET y POST<\/li>\n<li><strong>Formato de respuesta:<\/strong> JSON<\/li>\n<li><strong>URL base:<\/strong> <code>https:\/\/apps.kafinea.com\/{VotreInstance}\/webservice.php<\/code><\/li>\n<\/ul>\n<hr>\n<h2>Formato de las respuestas<\/h2>\n<h3>Respuesta positiva<\/h3>\n<pre><code class=\"language-json\">{\n  \"success\": true,\n  \"result\": {\n    \/\/ ...\n  }\n}\n<\/code><\/pre>\n<h3>Respuesta negativa<\/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>Resumen de las operaciones<\/h2>\n<div style=\"overflow-x:auto\">\n<table>\n<thead>\n<tr>\n<th>Operaci\u00f3n<\/th>\n<th>M\u00e9todo<\/th>\n<th>Descripci\u00f3n<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>getchallenge<\/code><\/td>\n<td>GET<\/td>\n<td>Obtener un token de conexi\u00f3n<\/td>\n<\/tr>\n<tr>\n<td><code>login<\/code><\/td>\n<td>POST<\/td>\n<td>Iniciar sesi\u00f3n<\/td>\n<\/tr>\n<tr>\n<td><code>logout<\/code><\/td>\n<td>POST<\/td>\n<td>Cerrar sesi\u00f3n<\/td>\n<\/tr>\n<tr>\n<td><code>extendsession<\/code><\/td>\n<td>GET<\/td>\n<td>Prolongar la sesi\u00f3n<\/td>\n<\/tr>\n<tr>\n<td><code>listtypes<\/code><\/td>\n<td>GET<\/td>\n<td>Listar los m\u00f3dulos disponibles<\/td>\n<\/tr>\n<tr>\n<td><code>describe<\/code><\/td>\n<td>GET<\/td>\n<td>Describir los campos de un m\u00f3dulo<\/td>\n<\/tr>\n<tr>\n<td><code>create<\/code><\/td>\n<td>POST<\/td>\n<td>Crear una entidad<\/td>\n<\/tr>\n<tr>\n<td><code>retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>Recuperar una entidad<\/td>\n<\/tr>\n<tr>\n<td><code>update<\/code><\/td>\n<td>POST<\/td>\n<td>Actualizar una entidad<\/td>\n<\/tr>\n<tr>\n<td><code>delete<\/code><\/td>\n<td>POST<\/td>\n<td>Eliminar una entidad<\/td>\n<\/tr>\n<tr>\n<td><code>query<\/code><\/td>\n<td>GET<\/td>\n<td>Consultar la base de datos<\/td>\n<\/tr>\n<tr>\n<td><code>query_related<\/code><\/td>\n<td>GET<\/td>\n<td>Consultar las listas relacionadas<\/td>\n<\/tr>\n<tr>\n<td><code>add_related<\/code><\/td>\n<td>POST<\/td>\n<td>A\u00f1adir una relaci\u00f3n entre entidades<\/td>\n<\/tr>\n<tr>\n<td><code>getPicklistValues<\/code><\/td>\n<td>GET<\/td>\n<td>Recuperar los valores de una lista desplegable<\/td>\n<\/tr>\n<tr>\n<td><code>setPicklistValues<\/code><\/td>\n<td>POST<\/td>\n<td>Modificar los valores de una lista desplegable<\/td>\n<\/tr>\n<tr>\n<td><code>FileUpload<\/code><\/td>\n<td>POST<\/td>\n<td>Subir un archivo<\/td>\n<\/tr>\n<tr>\n<td><code>files_retrieve<\/code><\/td>\n<td>GET<\/td>\n<td>Recuperar un archivo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<hr>\n<h2>Referencias asociadas \ud83d\udd17<\/h2>\n<ul>\n<li><a href=\"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-autenticacion\/\">Autenticaci\u00f3n<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-operaciones-crud\/\">Operaciones CRUD<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-relaciones-entre-entidades\/\">Operaciones vinculadas<\/a><\/li>\n<li><a href=\"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-solicitudes-y-consultas\/\">Peticiones y consultas<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Aproveche las API REST expuestas en HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Es libre de elegir la biblioteca que prefiera para trabajar con estas API. Principios generales La API de Kafinea es una API REST: usted se comunica directamente con su instancia de Kafinea y cada petici\u00f3n&#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":[758],"doc_tag":[],"class_list":["post-444453","docs","type-docs","status-publish","hentry","doc_category-api"],"year_month":"2026-07","word_count":241,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"David Valminos","author_nicename":"david","author_url":"https:\/\/www.kafinea.com\/es\/author\/david\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/www.kafinea.com\/es\/documentation\/api\/"}],"doc_tag_info":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.0 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Documentation - API REST - Introducci\u00f3n &#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\/es\/documentation\/api\/api-rest-introduccion\/\" \/>\n<meta property=\"og:locale\" content=\"es_ES\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documentation - API REST - Introducci\u00f3n &#8226; Kafinea\" \/>\n<meta property=\"og:description\" content=\"Aproveche las API REST expuestas en HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Es libre de elegir la biblioteca que prefiera para trabajar con estas API. Principios generales La API de Kafinea es una API REST: usted se comunica directamente con su instancia de Kafinea y cada petici\u00f3n...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/\" \/>\n<meta property=\"og:site_name\" content=\"Kafinea\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Tiempo de lectura\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minuto\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/api\\\/api-rest-introduccion\\\/\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/api\\\/api-rest-introduccion\\\/\",\"name\":\"Documentation - API REST - Introducci\u00f3n &#8226; Kafinea\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/#website\"},\"datePublished\":\"2026-04-02T21:39:26+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/api\\\/api-rest-introduccion\\\/#breadcrumb\"},\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/api\\\/api-rest-introduccion\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/api\\\/api-rest-introduccion\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/inicio\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/documentation\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API REST &#8211; Introducci\u00f3n\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/#website\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/\",\"name\":\"Kafinea\",\"description\":\"Une solution unique pour toutes vos ambitions\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"es\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/#organization\",\"name\":\"Kafinea\",\"url\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/www.kafinea.com\\\/es\\\/#\\\/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\\\/es\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/kafinea\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Documentation - API REST - Introducci\u00f3n &#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\/es\/documentation\/api\/api-rest-introduccion\/","og_locale":"es_ES","og_type":"article","og_title":"Documentation - API REST - Introducci\u00f3n &#8226; Kafinea","og_description":"Aproveche las API REST expuestas en HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Es libre de elegir la biblioteca que prefiera para trabajar con estas API. Principios generales La API de Kafinea es una API REST: usted se comunica directamente con su instancia de Kafinea y cada petici\u00f3n...","og_url":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/","og_site_name":"Kafinea","twitter_card":"summary_large_image","twitter_misc":{"Tiempo de lectura":"1 minuto"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/","url":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/","name":"Documentation - API REST - Introducci\u00f3n &#8226; Kafinea","isPartOf":{"@id":"https:\/\/www.kafinea.com\/es\/#website"},"datePublished":"2026-04-02T21:39:26+00:00","breadcrumb":{"@id":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/#breadcrumb"},"inLanguage":"es","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.kafinea.com\/es\/documentation\/api\/api-rest-introduccion\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.kafinea.com\/es\/inicio\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/www.kafinea.com\/es\/documentation\/"},{"@type":"ListItem","position":3,"name":"API REST &#8211; Introducci\u00f3n"}]},{"@type":"WebSite","@id":"https:\/\/www.kafinea.com\/es\/#website","url":"https:\/\/www.kafinea.com\/es\/","name":"Kafinea","description":"Une solution unique pour toutes vos ambitions","publisher":{"@id":"https:\/\/www.kafinea.com\/es\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.kafinea.com\/es\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"es"},{"@type":"Organization","@id":"https:\/\/www.kafinea.com\/es\/#organization","name":"Kafinea","url":"https:\/\/www.kafinea.com\/es\/","logo":{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/www.kafinea.com\/es\/#\/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\/es\/#\/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\/es\/author\/david\/"},"uagb_comment_info":0,"uagb_excerpt":"Aproveche las API REST expuestas en HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Es libre de elegir la biblioteca que prefiera para trabajar con estas API. Principios generales La API de Kafinea es una API REST: usted se comunica directamente con su instancia de Kafinea y cada petici\u00f3n...","_links":{"self":[{"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/docs\/444453","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/comments?post=444453"}],"version-history":[{"count":0,"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/docs\/444453\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/media?parent=444453"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/doc_category?post=444453"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.kafinea.com\/es\/wp-json\/wp\/v2\/doc_tag?post=444453"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}