Ver categorías

API REST – Introducción

1 minuto

Aprovecha las API REST disponibles a través de HTTP(s) para enviar o extraer datos de Kafinea e integrarlos en aplicaciones de terceros. Puedes elegir libremente la biblioteca que prefieras para trabajar con estas API.

Principios generales #

La API de Kafinea es una API REST: te comunicas directamente con tu instancia de Kafinea y cada solicitud es única e independiente. No se almacena nada en 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 operaciones #

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

Referencias relacionadas 🔗 #