Contents

• describe
• Interface version
• POST request address
• API List
  • 1.login
    • Request parameters
    • Request parameter description
    • Return to the example
    • Return to parameter description
  • 2.logout
    • Request parameters
    • Request parameter description
    • Return to the example
    • Return to parameter description

describe

• Login interface

Interface version

Version number	Maker	Date of formulation	Revision date
1.0	alan	2022-07-26

POST request address

http://192.168.1.1/api

API List

Name	Description
login	login interface
logout	Login interface

1.login

Request parameters

{
    "version": "1.0",
    "sid": "000000000000000000000000000000",
    "module":"login",
    "api":"login",
    "param": {
        "password":"YWRtaW4="
    }
}

Request parameter description

Parameter name	type	description
version	string	API version
sid	string	session id, login is all 0
module	string	requested module
api	string	requested api interface
param	json string	Request parameters with API
param.password	json string	Login password, base64 encrypted ciphertext, default login password is admin base64 encrypted YWRtaW4=

Return to the example

{
    "module": "login",
    "version": "1.0",
    "api": "login",
    "errcode": 0,
    "result": {
        "sid": "a25c00eed70abdf54d03680cfd8be804"
    },
    "sid": "000000000000000000000000000000"
}

Return to parameter description

Parameter name	type	description
module	string	requested module
version	string	api version
sid	string	requested sid
api	string	requested api name
errcode	string	Returned error code
data	array	API return result
result.sid	string	login, except for other module APIs in the Setup Wizard, you need to fill in sid

2.logout

Request parameters

{
    "version": "1.0",
    "sid": "a25c00eed70abdf54d03680cfd8be804",
    "module":"login",
    "api":"logout",
    "param": {
        "token":"a25c00eed70abdf54d03680cfd8be804"
    }
}

Request parameter description

Parameter name	type	description
version	string	API version
sid	string	login obtained session id
module	string	requested module
api	string	requested api interface
param	json string	Request parameters with API
param.token	json string	Sid number that needs to log out

Return to the example

{
    "module": "login",
    "version": "1.0",
    "api": "logout",
    "errcode": 0,
    "result": {},
    "sid": "a25c00eed70abdf54d03680cfd8be804"
}

Return to parameter description

Parameter name	type	description
module	string	requested module
version	string	api version
api	string	requested api name
errcode	string	Returned error code
result	string	api request returns to the interface, logout interface request returns to empty
sid	string	requested sid