{"id":444452,"date":"2026-04-03T02:43:24","date_gmt":"2026-04-03T00:43:24","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-authentication\/"},"modified":"2026-04-03T02:43:24","modified_gmt":"2026-04-03T00:43:24","password":"","slug":"rest-api-authentication","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-authentication\/","title":{"rendered":"REST API – Authentication"},"content":{"rendered":"

The login operation is a two-step process: obtain a token, then exchange credentials (username and access key).<\/p>\n

You can find your access key under “My Preferences” in the Kafinea web interface.<\/p>\n

\n

Step 1: Get a token (getchallenge)<\/h2>\n
\n

GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n

\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be getchallenge<\/code><\/td>\n<\/tr>\n
username<\/code><\/td>\nstring<\/td>\nyes<\/td>\nKafinea username<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Curl example:<\/strong><\/p>\n

curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=getchallenge&username=admin\"\n<\/code><\/pre>\n
Response:<\/strong><\/p>\n
{\n  \"success\": true,\n  \"result\": {\n    \"token\": \"[TOKENSTRING]\",\n    \"serverTime\": \"[TIMESTAMP]\",\n    \"expireTime\": \"[TIMESTAMP]\"\n  }\n}\n<\/code><\/pre>\n
\n
Step 2: Login (login)<\/h2>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  login<\/code><\/td>\n<\/tr>\n
username<\/code><\/td>\nstring<\/td>\nyes<\/td>\nKafinea username<\/td>\n<\/tr>\n
accessKey<\/code><\/td>\nstring<\/td>\nyes<\/td>\nmd5(token + accessKey)<\/code> \u2014 note: the K is uppercase<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=login\" \\\n  -d \"username=admin\" \\\n  -d \"accessKey=YOUR_MD5_HASH\"\n<\/code><\/pre>\n
Response:<\/strong><\/p>\n
{\n  \"success\": true,\n  \"result\": {\n    \"sessionId\": \"[STRING]\",\n    \"userId\": \"[STRING]\",\n    \"version\": \"[STRING]\",\n    \"kafineaVersion\": \"[STRING]\"\n  }\n}\n<\/code><\/pre>\n
\n
Logout (logout)<\/h2>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  logout<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID obtained at login<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=logout\" \\\n  -d \"sessionName=YOUR_SESSION_ID\"\n<\/code><\/pre>\n
\n
Extend session (extendsession)<\/h2>\n
If you need to extend your session duration, use this operation.<\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  extendsession<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=extendsession\"\n<\/code><\/pre>\n
\n
Related References \ud83d\udd17<\/h2>\n