Ver categorías

API REST – Autenticación

2 minutos

El proceso de inicio de sesión consta de dos pasos: obtener un token y, a continuación, introducir las credenciales (nombre de usuario y contraseña).

Puedes encontrar tu clave de acceso en «Mis preferencias» en la interfaz web de Kafinea.

Paso 1: Obtener un token (getchallenge) #

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser getchallenge
username cadena sí Nombre de usuario: Kafinea

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=getchallenge&username=admin"

Respuesta:

{
  "success": true,
  "result": {
    "token": "[TOKENSTRING]",
    "serverTime": "[TIMESTAMP]",
    "expireTime": "[TIMESTAMP]"
  }
}

Paso 2: Inicio de sesión #

PUBLICAR https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser login
username cadena sí Nombre de usuario: Kafinea
accessKey cadena sí md5(token + accessKey) — Atención: la K va en mayúscula

Ejemplo de curl:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=login" \
  -d "username=admin" \
  -d "accessKey=YOUR_MD5_HASH"

Respuesta:

{
  "success": true,
  "result": {
    "sessionId": "[STRING]",
    "userId": "[STRING]",
    "version": "[STRING]",
    "kafineaVersion": "[STRING]"
  }
}

Cerrar sesión (logout) #

PUBLICAR https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser logout
sessionName cadena sí Identificador de sesión obtenido al iniciar sesión

Ejemplo de curl:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=logout" \
  -d "sessionName=YOUR_SESSION_ID"

Prolongar la sesión (extendsession) #

Si necesita prolongar la duración de su sesión, utilice esta opción.

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser extendsession

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=extendsession"

Referencias relacionadas 🔗 #