View Categories

API REST – Authentification

2 minutes

API REST – Authentification #

L’opération de connexion est un processus en deux étapes : obtenir un token, puis échanger les informations d’identification (nom d’utilisateur et clé d’accès).

Vous pouvez trouver votre clé d’accès sous « Mes préférences » dans l’interface web de Kafinea.

Étape 1 : Obtenir un token (getchallenge) #

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

Paramètre Type Requis Description
operation string oui Doit être getchallenge
username string oui Nom d’utilisateur Kafinea

Exemple curl :

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

Réponse :

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

Étape 2 : Connexion (login) #

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

Paramètre Type Requis Description
operation string oui Doit être login
username string oui Nom d’utilisateur Kafinea
accessKey string oui md5(token + accessKey) — attention : le K est majuscule

Exemple curl :

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

Réponse :

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

Déconnexion (logout) #

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

Paramètre Type Requis Description
operation string oui Doit être logout
sessionName string oui Identifiant de session obtenu au login

Exemple curl :

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

Prolonger la session (extendsession) #

Si vous devez prolonger la durée de votre session, utilisez cette opération.

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

Paramètre Type Requis Description
operation string oui Doit être extendsession

Exemple curl :

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

Références associées 🔗 #