1 用户登录接口文档

SimOne Web User Server

1.1 登录接口

Path: /api-user/user/login

Method: GET

Headers: Headers

请求参数

参数名称

传参格式

说明

是否必须

类型

示例

username

query

账号名称

Yes

string

zhangsan

password

query

鉴权 token,有效期 30s

Yes

string

qKP1Cgv3NysooGPKHRiiKGqQEjLjkbBFy2FqbkaY6ew

返回数据

字段名

说明

是否必填

类型

token

当前用户鉴权 Token

Yes

string

备注:

密码是通过一定加密算法计算得到的需要联系售后支持以获取生成方法


1.2 获取用户登录 token

Path: /api-user/user/check

Method: POST

Headers: Headers

请求参数

参数名称

位于

说明

是否必填

类型

username

body

用户 id

Yes

string

返回数据

字段名

说明

是否必填

类型

checkToken

当前用户鉴权 Token

Yes

string


1.3 单机版获取 authToken

Path: /api-user/user/standalone

Method: GET

Headers: Headers

返回数据

字段名

说明

是否必填

类型

token

当前用户鉴权 Token

Yes

string


1.4 登出

Path: /api-user/user/logout

Method: POST

Headers: Headers

返回数据


1.5 判断是否为云端环境

Path: /api-user/user/isCloud

Method: GET

Headers: Headers

返回数据

字段名

说明

是否必填

类型

isCloud

是否云端环境

Yes

boolean


通用请求头

Headers

参数名称

参数值

是否必填

示例

Content-Type

application/json

Yes

Authorization

string

Yes

“6a82749b-7d4e-46a3-a932-e5ca21f34f16”

projectId

string 默认值: "default"

Yes