View Categories

API REST – Autenticación

1 minutes

La operación de inicio de sesión es un proceso de dos pasos: obtener un token y luego intercambiar las credenciales (nombre de usuario y clave de acceso).

Puede encontrar su 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 Requerido Descripción
operation string sí Debe ser getchallenge
username string sí Nombre de usuario de Kafinea

Ejemplo 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 (login) #

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

Parámetro Tipo Requerido Descripción
operation string sí Debe ser login
username string sí Nombre de usuario de Kafinea
accessKey string sí md5(token + accessKey) — atención: la K es mayúscula

Ejemplo 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) #

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

Parámetro Tipo Requerido Descripción
operation string sí Debe ser logout
sessionName string sí ID de sesión obtenido al iniciar sesión

Ejemplo curl:

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

Extender sesión (extendsession) #

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

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

Parámetro Tipo Requerido Descripción
operation string sí Debe ser extendsession

Ejemplo curl:

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

Referencias asociadas 🔗 #