User Login API

1 User Login API Documentation

SimOne Web User Server

1.1 Login API

Path： /api-user/users/login

Method： POST

Headers：Headers

Request Parameters

Parameter	Location	Description	Required	Type	Example
username	body	Account name	Yes	string	zhangsan
password	body	AES-ECB encrypted password string (checkToken concatenated with original password, then encrypted and base64-encoded). For the encryption method, see sample_1_login.md	Yes	string	qKP1Cgv3NysooGPKHRiiKGqQEjLjkbBFy2FqbkaY6ew

Response Data

Field	Description	Required	Type
token	Authentication Token for the current user	Yes	string

Notes:

The password is computed via a specific encryption algorithm. Contact after-sales support to obtain the generation method.

1.2 Get User Login Token

Path： /api-user/user/check

Method： POST

Headers：Headers

Request Parameters

Parameter	Location	Description	Required	Type
username	body	User ID	Yes	string

Response Data

Field	Description	Required	Type
checkToken	Authentication Token for the current user	Yes	string

1.3 Get authToken (Standalone Edition)

Path： /api-user/user/standalone

Method： GET

Headers：Headers

Response Data

Field	Description	Required	Type
token	Authentication Token for the current user	Yes	string

1.4 Logout

Path： /api-user/user/logout

Method： POST

Headers：Headers

Response Data

None

1.5 Check Whether Running in Cloud Environment

Path： /api-user/user/isCloud

Method： GET

Headers：Headers

Response Data

Field	Description	Required	Type
isCloud	Whether running in cloud environment	Yes	boolean

Common Request Headers

Headers

Parameter	Value	Required	Example	Notes
Content-Type	application/json	Yes
Authorization	string	Yes	"6a82749b-7d4e-46a3-a932-e5ca21f34f16"
projectId	string, default: "default"	Yes		3.7.0