更新时间:2022-08-25 GMT+08:00
分享

请求认证

接口名称

WEB_RequestCertificateAPI

功能描述

调用该接口请求认证,校验用户名、密码。并返回CSRF Token。

应用场景

通过该接口将用户名、密码等发到服务器端校验。如果校验成功,则认证通过并返回CSRFToken,后续所有json数据请求都必须带上CSRF Token字段。反之,返回失败响应,认证不通过。通过HTTP API接口对终端的操作,前提是认证通过。

URL

https://ip/action.cgi?ActionID=WEB_RequestCertificateAPI

参数

表1 请求认证参数

参数

类型

取值范围

参数说明

user

string

不为空

用户名

password

string

不为空

密码

返回值

表2 请求认证返回值

参数

类型

取值范围

参数说明

success

int

[0, 1]

响应结果

0:失败

1:成功

data

Object

可选

成功返回数据。详细参考表3

例如:{"success":1,"data":"{\"acCSRFToken\":\"s9C1zjO5HLnSf9u4eKP9uKfn8Kb9T94j\"}"}

error

Object

可选

失败返回错误信息。详细参考表4

例如:{"success":0,"error":"id":100666995,"code":33558532,"params":[]}}

表3 data

参数

类型

取值范围

参数说明

acCSRFToken

string

不允许为空

acCSRFToken为登录token,后续报文发送中均需要使用此token。

表4 error

参数

类型

取值范围

参数说明

id

int

32位整数

错误id,用于转换。

code

int

32位整数

错误码,跟错误id对应,具体含义参考错误码

param

Object

param 对象

失败响应的附带参数。

相关文档