diff --git a/doc/api/http_api.md b/doc/api/http_api.md index 7ace1b0b7..e73109b01 100644 --- a/doc/api/http_api.md +++ b/doc/api/http_api.md @@ -407,3 +407,12 @@ sends a custom message of type `msg` to the pad *Example returns:* * `{code: 0, message:"ok", data: {}}` * `{code: 1, message:"padID does not exist", data: null}` + +#### checkToken() + * API >= 1 + +returns ok when api token is valid + +*Example returns:* + * `{"code":0,"message":"ok","data":null}` + * `{"code":4,"message":"no or wrong API Key","data":null}` diff --git a/src/node/db/API.js b/src/node/db/API.js index 4979e8c65..ea58d8599 100644 --- a/src/node/db/API.js +++ b/src/node/db/API.js @@ -548,6 +548,19 @@ exports.sendClientsMessage = function (padID, msg, callback) { } ); } +/** +checkToken() returns ok when api token is valid + +Example returns: + +{"code":0,"message":"ok","data":null} +{"code":4,"message":"no or wrong API Key","data":null} +*/ +exports.checkToken = function(callback) +{ + callback(); +} + /******************************/ /** INTERNAL HELPER FUNCTIONS */ diff --git a/src/node/handler/APIHandler.js b/src/node/handler/APIHandler.js index f99762cea..198ec97b3 100644 --- a/src/node/handler/APIHandler.js +++ b/src/node/handler/APIHandler.js @@ -68,6 +68,7 @@ var version = , "isPasswordProtected" : ["padID"] , "listAuthorsOfPad" : ["padID"] , "padUsersCount" : ["padID"] + , "checkToken" : [] } , "1.1": { "createGroup" : [] @@ -102,6 +103,7 @@ var version = , "padUsers" : ["padID"] , "sendClientsMessage" : ["padID", "msg"] , "listAllGroups" : [] + , "checkToken" : [] } };