Log in to devices - 播放盒-EN

1、Pre-operations
（1）Search for devices
Search the device through the search interface and obtain basic information about the device: IP address, SN (product serial number), product name, etc.

2、Post-operations
In each subsequent request, it is necessary to include the Token sent during login in the request header. The name of the request header is "Authorization", and the value is the Token sent during login.

3、Prevent brute force login
After three consecutive failed attempts, users must wait 60 seconds before trying again.

4、Flowchart

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/x-msgpack

string

required

username

string

username

required

username

password

string

password

required

password

loginType

integer

type

required

Fixed value: 2

clientId

integer

Unique identifier on the link end

required

Same clientId will share a token, while the tokens of different clientIds will vary. For example: 1 Note: If two clients have the same clientId, it may result in the forced logout of one client upon the login of the other.

clientName

string

Link end name

required

Link end description, for example, ViPlex Express

Example

{
  "sn": "10016102136445658ABC",
  "username": "admin",
  "password": "88888888",
  "loginType": 2,
  "clientId": 1,
  "clientName": "Express-PC"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

integer

Status code

required

Status Codes OK = 0; Success ERROR = 1; Failure ERR_INVALID_PARAM = 3; Parameter error ERR_FORBIDDEN = 17; Too many login attempts ERR_NOT_EXISTED = 19; Login configuration not found on server ERR_VERIFY_FAILED = 24; Incorrect username or password

message

string

Detailed information

required

data

object

Data structure

required

logined

boolean

Whether login is successful

required

False is returned when login fails.

string

required

token

string

token

optional

username

string

username

required

password

string

password

required

validation

boolean

check result

required

Example

{
  "code": 0,
  "message": "",
  "data": {
    "logined": true,
    "password": "tester",
    "sn": "10016102136445658ABC",
    "token": "1722678297190UWSo6okfy123",
    "username": "admin",
    "validation": true
  }
}

🟢200Error