View Categories

API REST – Introducción

1 minutes

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ón es única e independiente. No se almacena nada en la caché.

  • Protocolo: HTTP(s)
  • Métodos: GET y POST
  • Formato de respuesta: JSON
  • URL base: https://apps.kafinea.com/{VotreInstance}/webservice.php

Formato de las respuestas #

Respuesta positiva #

{
  "success": true,
  "result": {
    // ...
  }
}

Respuesta negativa #

{
  "success": false,
  "error": {
    "message": "[STRING]",
    "code": "[STRING]"
  }
}

Resumen de las operaciones #

Operación Método Descripción
getchallenge GET Obtener un token de conexión
login POST Iniciar sesión
logout POST Cerrar sesión
extendsession GET Prolongar la sesión
listtypes GET Listar los módulos disponibles
describe GET Describir los campos de un módulo
create POST Crear una entidad
retrieve GET Recuperar una entidad
update POST Actualizar una entidad
delete POST Eliminar una entidad
query GET Consultar la base de datos
query_related GET Consultar las listas relacionadas
add_related POST Añadir una relación entre entidades
getPicklistValues GET Recuperar los valores de una lista desplegable
setPicklistValues POST Modificar los valores de una lista desplegable
FileUpload POST Subir un archivo
files_retrieve GET Recuperar un archivo

Referencias asociadas 🔗 #