Browser Profile

Updated by lei_jiang

1 Start browser profile

Basic Information

POST  /api/env/start

Description: Used to start the profile, you need to specify the profile ID, after successful startup, you can get the profile debug interface for the execution of selenium and puppeteer automation. Selenium needs to use the Webdriver that matches the corresponding kernel version, you can get the path of the corresponding Webdriver in the return value after starting the profile. You need to update MoreLogin client to version 2.15.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter Name

Type

Required

Description

envId

string

NO

Profile ID

Send the profile ID or the profile order number. If both are sent, the profile ID takes precedence.

uniqueId

integer(int32)

NO

Profile order number

Send the profile ID or the profile order number. If both are sent, the profile ID takes precedence.

encryptKey

string

NO

Private key, mandatory when enabling end-to-end encryption in the profile

Example of a request

{
"envId": "1795695767353204736",
"encryptKey": "xxx"
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // error message
"data": {
"envId": "1795695767353204736", // Profile ID
"debugPort": "61598" // debug port
}
}

2 Stop browser profile

Basic Information

POST  /api/env/close

Description: Stopping the specified environment requires the specified profile ID. You need to update MoreLogin client to version 2.15.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter Name

Type

Required

Description

envId

string

NO

Profile ID

Send the profile ID or the profile order number. If both are sent, the profile ID takes precedence.

uniqueId

integer(int32)

NO

Profile order number

Send the profile ID or the profile order number. If both are sent, the profile ID takes precedence.

Example of a request

{
"envId": "1795695767353204736"
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // error message
"data": {
"envId": "1795695767353204736", // Profile ID
}
}

3 Quick create browser profile

Basic Information

POST  /api/env/create/quick

Description: Quickly create profiles with support for setting the profiles' browser, operating system, and the number of profiles to create. Returns the profile ID after successful creation. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

browserTypeId

integer(int32)

YES

Browser type 

1:Chrome,2: Firefox

operatorSystemId

integer(int32)

YES

Operating system type

1:Windows,2:macOS,3:Android,4:IOS

quantity

integer(int32)

YES

Number of profiles created, numerical range: [1-50]

browserCore

integer(int32)

NO

Kernel version number, default: 0 - Auto Match

Available kernel versions can be obtained through the “get browser kernel version” interface.

groupId

integer(int64)

NO

Profile group ID, default: ungrouped -0

Note: In grouped authorization mode, this field is required if you do not have “All Profiles” permission.

 isEncrypt

integer(int32)

NO

Whether to enable “End-to-End Encryption"

0: off, 1: on, default 0

Example of a request

{
"browserTypeId": 0,
"groupId": 0,
"isEncrypt": 0,
"operatorSystemId": 0,
"quantity": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": [1,2,3], // Profile ID array
"requestId": "", // Operation request ID
}

4 Advanced create browser profile

Basic Information

POST /api/env/create/advanced

Description: Advanced create profile, support to set platform account password, cookie, fingerprint information and so on for the profile. Returns the profile ID after successful creation. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

browserTypeId

integer(int32)

YES

Browser type 

1:Chrome,2: Firefox

operatorSystemId

integer(int32)

YES

Operating system type

1:Windows,2:macOS,3:Android,4:IOS

envName

string

NO

Profile name, length limit 100 characters

accountInfo

NO

Profile account information

advancedSetting

object

NO

Advanced setting

afterStartupConfig

NO

Configuration after profile startup

browserCore

integer(int32)

NO

Kernel version number, default: 0 - Auto Match

Available kernel versions can be obtained through the “get browser kernel version” interface.

cookies

string

NO

Cookie

envRemark

string

NO

Profile remarks, length limit 1500 characters

groupId

integer(int64)

NO

Profile group ID, default: not grouped -0, limit minimum value 0

Note: In group authorization mode, if you don't have “All profiles” permission, this field is required.

isEncrypt

integer(int32)

NO

Whether to enable “End-to-End Encryption"

0: off, 1: on, default 0

proxyId

integer(int64)

NO

Proxy ID, default: 0, limit minimum value 0

tagIds

array

NO

Tag ID, default: null

uaVersion

integer(int32)

NO

UA, default: 0-all

Available UA versions can be obtained through the “Get a list of browser kernel versions” interface.

accountInfo

Parameter name

Type

Required

Description

platformId

integer(int64)

YES

Platform ID

9999 - Customized platforms, the rest of the platform IDs can be obtained through the “get configurable platforms” interface.

customerUrl

string

NO

Customized platform URL, required when platform ID=9999, must be a legitimate url address

username

string

NO

User name, length limit 64 characters

password

string

NO

Password, length limit 50 characters

otpSecret

string

NO

2FA key

Generates secondary verification codes for websites, similar to Google Authenticator.

siteId

integer(int64)

NO

Site ID

Available through the “get configurable platform” interface

advancedSetting

Parameter name

Type

Required

Description

ua

string

NO

Customize the profile UA, the format should be uploaded according to the standard format.

Available through the “get browser UA” interface.

time_zone

object {2}

NO

Timezone

web_rtc

object {1}

NO

WebRTC

geo_location

object {5}

NO

Geographic location

language

object {2}

NO

Language

resolution

object {2}

NO

Resolution

font

object {2}

NO

Font

canvas

object {1}

NO

Canvas

webgl_image

object {1}

NO

WebGL image

webgl_metadata

object {1}

NO

WebGL metabase

audio_context

object {1}

NO

AudioContext

media_device

object {1}

NO

Media device

client_rects

object {1}

NO

ClientRects

speech_voise

object {1}

NO

SpeechVoices

hardware_concurrency

int

NO

Hardware concurrency, default: 4

0 (real concurrency), 2, 3, 4, 6, 8, 10, 12

memery_device

int

NO

Device memory, default: 8

0 (real memory), 2, 4, 6, 8

do_not_track

int

NO

Do Not Track, default: 2

1: on, 2: off

bluetooth

object {1}

NO

Bluetooth

battery

object {1}

NO

Battery

port_scan_protectio

object {2}

NO

Port scan protection

os_version

string

NO

MacOS system version

For example: macOS 12, macOS 13, macOS 14

web_gpu

object {1}

NO

WebGPU

time_zone

Parameter name

Type

Required

Description

switcher

int

NO

Timezone option, default 1

1: Match IP, 2: Custom

value

string

NO

When the switcher sends 2, it is mandatory to send the corresponding time zone ID

Can be obtained through the "get timezone language list" interface

web_rtc

Parameter name

Type

Required

Description

switcher

int

NO

WebRTC option, default 2

1: Privacy, 2: Replacement, 3: Real, 4: Disabled, 5: Forwarding

geo_location

Parameter name

Type

Required

Description

switcher

int

NO

Geographical location option, default: 1

1: Inquiry, 2: Disabled

base_on_ip

bool

NO

Whether to generate based on IP, default: true

True: Inquire, False: No

latitude

float

NO

Latitude, mandatory when generating corresponding geographic locations without IP

longitude

float

NO

Longitude, mandatory when generating corresponding geographic locations without IP

accuracy

float

NO

Accuracy (in meters), must be transmitted when generating corresponding geographic locations without IP

language

Parameter name

Type

Required

Description

switcher

int

NO

Language options, default: 1

1: Match IP, 2: Custom

value

string

NO

When the switcher sends 2, it is mandatory to send the language ID

Can be obtained through the "get timezone language list" interface

resolution

Parameter name

Type

Required

Description

switcher

int

NO

Resolution option, default: 1

1: Real, 2: Custom

id

string

NO

When the switcher sends 2, it is mandatory to send the language ID

Can be obtained through the "obtain resolution" interface

font

Parameter name

Type

Required

Description

switcher

int

NO

Font options, default: 1

1: Real, 2: Custom

value

string

NO

Switcher must be filled in when selecting custom font, separated by commas

Available fonts can be found in the attachment

canvas

Parameter name

Type

Required

Description

switcher

int

NO

Canvas option, default: 1

1: Noise, 2: Real

webgl_image

Parameter name

Type

Required

Description

switcher

int

NO

WebGL image options, default: 1

1: Noise, 2: Real

webgl_metadata

Parameter name

Type

Required

Description

switcher

int

NO

WebGL metadata options, default: 3

1: Real, 2: Turn off hardware acceleration, 3: Custom

audio_context

Parameter name

Type

Required

Description

switcher

int

NO

AudioContext option, default: 1

1: Noise, 2: Realistic

media_device

Parameter name

Type

Required

Description

switcher

int

NO

Media device options, default: 1

1: Noise, 2: Real

client_rects

Parameter name

Type

Required

Description

switcher

int

NO

ClientReacts option, default: 1

1: Noise, 2: Real

speech_voise

Parameter name

Type

Required

Description

switcher

int

NO

SSpeedVoices option, default: 1

1: Privacy, 2: Real

bluetooth

Parameter name

Type

Required

Description

switcher

int

NO

Bluetooth option, default: 1

1: Privacy, 2: Authenticity

battery

Parameter name

Type

Required

Description

switcher

int

NO

Bluetooth option, default: 1

1: Privacy, 2: Authenticity

port_scan_protection

Parameter name

Type

Required

Description

switcher

int

NO

Port scan protection option, default: 1

1: On, 2: Off

value

string

NO

Allowed local network ports to be connected

web_gpu

Parameter name

Type

Required

Description

switcher

int

NO

WebGPU options, default: 1

1: WebGL-based matching, 2: true, 3: disabled

afterStartupConfig

Parameter name

Type

Required

Description

afterStartup

integer(int32)

NO

Set after startup, default: 1

1: Continue browsing the last opened webpage, 2: Open the specified webpage, 3: Open the specified webpage and platform, 4: Continue browsing the last opened webpage and platform

autoOpenUrls

array

NO

Open the specified webpage address, which must be a valid URL address

Example of a request

{
"accountInfo": {
"customerUrl": "",
"password": "",
"platformId": 0,
"siteId": 0,
"username": ""
},
"advancedSetting": {},
"afterStartupConfig": {
"afterStartup": 0,
"autoOpenUrls": []
},
"browserCore": 0,
"browserTypeId": 0,
"cookies": "",
"envName": "",
"envRemark": "",
"groupId": 0,
"isEncrypt": 0,
"operatorSystemId": 0,
"proxyId": 0,
"tagIds": [],
"uaVersion": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": 0, // Profile ID
"requestId": "", // Operation request ID
}

5 Modify browser profile

Basic Information

POST  /api/env/update

Description: Modify profile parameters, including profile name, proxy information, fingerprint information, etc. After successful creation, return the profile ID. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

envId

integer(int64)

YES

Profile ID

envName

string

NO

Profile name, length limit of 100 characters

accountInfo

NO

Profile account information

advancedSetting

object

NO

Advanced setting

afterStartupConfig

NO

Related configurations after profile start

browserCore

integer(int32)

NO

Kernel version number, default: 0- Auto match

Available kernel versions can be obtained through the "get browser kernel version" interface

cookies

string

NO

Cookie

envRemark

string

NO

Profile remarks, length limit 1500 characters

groupId

integer(int64)

NO

Profile group ID, default: not grouped -0, limit minimum value 0

Note: In group authorization mode, if you don't have “all profiles” permission, this field is required.

isEncrypt

integer(int32)

NO

Whether to enable “End-to-End" Encryption

0: off, 1: on, default 0

proxyId

integer(int64)

NO

Proxy ID, default: 0, limit minimum value 0

tagIds

array

NO

Tag ID, default: null

uaVersion

integer(int32)

NO

UA, default: 0-all

Available UA versions can be obtained through the “Get a list of browser kernel versions” interface.

accountInfo

Parameter name

Type

Required

Description

platformId

integer(int64)

YES

Platform ID

9999 - Customized platforms, the rest of the platform IDs can be obtained through the “get configurable platforms” interface.

customerUrl

string

NO

Customized platform URL, required when platform ID=9999, must be a legitimate url address

username

string

NO

User name, length limit 64 characters

password

string

NO

Password, length limit 50 characters

otpSecret

string

NO

2FA key

Generates secondary verification codes for websites, similar to Google Authenticator.

siteId

integer(int64)

NO

Site ID

Available through the “get configurable platform” interface

advancedSetting

Parameter name

Type

Required

Description

ua

string

NO

Customize the profile UA, the format should be uploaded according to the standard format.

Available through the “get browser UA” interface.

time_zone

object {2}

NO

Timezone

web_rtc

object {1}

NO

WebRTC

geo_location

object {5}

NO

Geographic location

language

object {2}

NO

Language

resolution

object {2}

NO

Resolution

font

object {2}

NO

Font

canvas

object {1}

NO

Canvas

webgl_image

object {1}

NO

WebGL image

webgl_metadata

object {1}

NO

WebGL metabase

audio_context

object {1}

NO

AudioContext

media_device

object {1}

NO

Media device

client_rects

object {1}

NO

ClientRects

speech_voise

object {1}

NO

SpeechVoices

hardware_concurrency

int

NO

Hardware concurrency, default: 4

0 (real concurrency), 2, 3, 4, 6, 8, 10, 12

memery_device

int

NO

Device memory, default: 8

0 (real memory), 2, 4, 6, 8

do_not_track

int

NO

Do Not Track, default: 2

1: on, 2: off

bluetooth

object {1}

NO

Bluetooth

battery

object {1}

NO

Battery

port_scan_protectio

object {2}

NO

Port scan protection

os_version

string

NO

MacOS system version

For example: macOS 12, macOS 13, macOS 14

web_gpu

object {1}

NO

WebGPU

time_zone

Parameter name

Type

Required

Description

switcher

int

NO

Timezone option, default 1

1: Match IP, 2: Custom

value

string

NO

When the switcher sends 2, it is mandatory to send the corresponding time zone ID

Can be obtained through the "get timezone language list" interface

web_rtc

Parameter name

Type

Required

Description

switcher

int

NO

WebRTC option, default 2

1: Privacy, 2: Replacement, 3: Real, 4: Disabled, 5: Forwarding

geo_location

Parameter name

Type

Required

Description

switcher

int

NO

Geographical location option, default: 1

1: Inquiry, 2: Disabled

base_on_ip

bool

NO

Whether to generate based on IP, default: true

True: Inquire, False: No

latitude

float

NO

Latitude, mandatory when generating corresponding geographic locations without IP

longitude

float

NO

Longitude, mandatory when generating corresponding geographic locations without IP

accuracy

float

NO

Accuracy (in meters), must be transmitted when generating corresponding geographic locations without IP

language

Parameter name

Type

Required

Description

switcher

int

NO

Language options, default: 1

1: Match IP, 2: Custom

value

string

NO

When the switcher sends 2, it is mandatory to send the language ID

Can be obtained through the "get timezone language list" interface

resolution

Parameter name

Type

Required

Description

switcher

int

NO

Resolution option, default: 1

1: Real, 2: Custom

id

string

NO

When the switcher sends 2, it is mandatory to send the language ID

Can be obtained through the "obtain resolution" interface

font

Parameter name

Type

Required

Description

switcher

int

NO

Font options, default: 1

1: Real, 2: Custom

value

string

NO

Switcher must be filled in when selecting custom font, separated by commas

Available fonts can be found in the attachment

canvas

Parameter name

Type

Required

Description

switcher

int

NO

Canvas option, default: 1

1: Noise, 2: Real

webgl_image

Parameter name

Type

Required

Description

switcher

int

NO

WebGL image options, default: 1

1: Noise, 2: Real

webgl_metadata

Parameter name

Type

Required

Description

switcher

int

NO

WebGL metadata options, default: 3

1: Real, 2: Turn off hardware acceleration, 3: Custom

audio_context

Parameter name

Type

Required

Description

switcher

int

NO

AudioContext option, default: 1

1: Noise, 2: Realistic

media_device

Parameter name

Type

Required

Description

switcher

int

NO

Media device options, default: 1

1: Noise, 2: Real

client_rects

Parameter name

Type

Required

Description

switcher

int

NO

ClientReacts option, default: 1

1: Noise, 2: Real

speech_voise

Parameter name

Type

Required

Description

switcher

int

NO

SSpeedVoices option, default: 1

1: Privacy, 2: Real

bluetooth

Parameter name

Type

Required

Description

switcher

int

NO

Bluetooth option, default: 1

1: Privacy, 2: Authenticity

battery

Parameter name

Type

Required

Description

switcher

int

NO

Bluetooth option, default: 1

1: Privacy, 2: Authenticity

port_scan_protection

Parameter name

Type

Required

Description

switcher

int

NO

Port scan protection option, default: 1

1: On, 2: Off

value

string

NO

Allowed local network ports to be connected

web_gpu

Parameter name

Type

Required

Description

switcher

int

NO

WebGPU options, default: 1

1: WebGL-based matching, 2: true, 3: disabled

afterStartupConfig

Parameter name

Type

Required

Description

afterStartup

integer(int32)

NO

Set after startup, default: 1

1: Continue browsing the last opened webpage, 2: Open the specified webpage, 3: Open the specified webpage and platform, 4: Continue browsing the last opened webpage and platform

autoOpenUrls

array

NO

Open the specified webpage address, which must be a valid URL address

Example of a request

{
"accountInfo": {
"customerUrl": "",
"password": "",
"platformId": 0,
"siteId": 0,
"username": ""
},
"advancedSetting": {},
"afterStartupConfig": {
"afterStartup": 0,
"autoOpenUrls": []
},
"browserCore": 0,
"cookies": "",
"envName": "",
"envRemark": "",
"groupId": 0,
"id": 0,
"proxyId": 0,
"tagIds": [],
"uaVersion": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"requestId": "", // Operation request ID
}

6 Delete browser profile

Basic Information

POST  /api/env/removeToRecycleBin/batch

Description: Delete unwanted profiles and retrieve them in the Trash within 7 days after deletion. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

envIds

array

YES

Profile IDs

Example of a request

{
"envIds": []
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": true,
"requestId": "", // Operation request ID
}

7 Get a list of browser profiles

Basic Information

POST  /api/env/page

Description: Queries the added profile information. Users can query only the profile information to which they have access. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

pageNo

integer(int64)

YES

Current page, default 1

pageSize

integer(int64)

YES

Number of articles per page, default 10

envName

string

NO

Search by profile name

groupId

integer(int64)

NO

Query by group ID, 0: not grouped

envId

integer(int64)

NO

Search by profile id

Example of a request

{
"envName": "",
"groupId": 0,
"envId": 0,
"pageNo": 0,
"pageSize": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"current": 0,
"dataList": [ // Profile list information
{
"envName": "", // Profile name
"groupId": 0, // Group ID
"id": 0, // Profile ID
"proxyId": 0 // Proxy ID
}
],
"pages": 0,
"total": 0
},
"requestId": "", // Operation request ID
}

8 Get browser profile details

Basic Information

POST  /api/env/detail

Description: Query profile details. Users can only query profile information for which they have permission. You need to update MoreLogin client to version 2.14.0 or above.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

envId

integer(int64)

YES

The profile ID to be queried

Example of a request

{
"envId": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"accountInfo": { // Account information
"customerUrl": "", // Custom platform URL
"password": "", // Password
"platformId": 0, // Platform ID
"siteId": 0, // Site ID
"username": "" // User name
},
"advancedSetting": {}, // Advanced setting
"afterStartupConfig": { // Configuration information after startup
"afterStartup": 0, // After startup settings: 1: Continue browsing the last opened webpage, 2: Open the specified webpage, 3: Open the specified webpage and platform, 4: Continue browsing the last opened webpage and platform
"autoOpenUrls": [], // Open the specified webpage information
"platformUrl": "" // Platform address
},
"browserCore": 0, // Kernel version number
"browserTypeId": 0, // Browser type, 1:Chrome,2: Firefox
"cookies": "", // Cookie
"envName": "", // Profile name
"envRemark": "", // Profle remark
"groupId": 0, // Group ID
"id": 0, // profile ID
"isEncrypt": 0, // Whether “end-to-end encryption”, 0: No, 1: Yes
"operatorSystemId": 0, // Operating system type, 1:Windows,2:macOS,3:Android,4:IOS
"proxyId": 0, // Proxy ID
"tagIds": [], // Tag ID
"uaVersion": 0 // UA
}
"requestId": "", // Operation request ID
}

9 Get a list of browser kernel versions

Basic Information

GET  /api/env/advanced/ua/versions

Description: Queries the available browser kernel versions. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": [
{
"browserType": 0, // Browser type, 1:Chrome,2: Firefox
"versions": [] // Version
}
],
"requestId": "", // Operation request ID
}

10 Get browser profile UA

Basic Information

POST  /api/env/advanced/ua/get

Description: Get the available browser profile UA. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

os

integer(int32)

YES

Corresponding to different operating systems

1:Windows,2:macOS,3:Android,4:IOS

osVersion

string

NO

System version

Includes: Windows 7-11, macOS 12-14

vendor

integer(int32)

YES

Corresponding to different browser type

1:Chrome,2: Firefox

Example of a request

{
"os": 0,
"osVersion": "",
"vendor": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"resolution": { // Default resolution value
"id": "", // Resolution ID
"value": "" // Resolution value
},
"ua": "" // UA
},
"requestId": "", // Operation request ID
}

11 Get resolution

Basic Information

POST  /api/env/base/resolution/list

Description: Get available resolution based on UA. You need to update MoreLogin client to version 2.14.0 or above.

Note: To use this interface, you need to start the MoreLogin client and successfully log in.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

os

integer(int32)

YES

Corresponding to different operating system

1:Windows,2:macOS,3:Android,4:IOS

ua

string

NO

UA

Example of a request

{
"os": 0,
"ua": ""
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": [
{
"id": "", // Resolution ID
"value": "" // Resolution value
}
],
"requestId": "", // Operation request ID
}

12 Get configurable platforms

Basic Information

GET  /api/system/platform/list

Description: Get available platform information. You need to update MoreLogin client to version 2.14.0 or above.

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": [
{
"categoryId": 0, // Category ID
"groupName": "", // Group name
"groups": 0, // Group,0:Amazon
"id": 0, // Platform ID
"isCustomer": true, // Whether to customize the platform
"logo": "", // Platform logo
"name": "", // Platform name
"orderNo": 0, // Sort Number
"sites": [ // Sites information
{
"country": "", // Country
"host": "", // Site Domain Name
"id": 0, // Site ID
"isDefault": true, // LanguageID
"logo": "", // Logo
"name": "", // Size name
"nameBak": "", // Size name backup
"url": "" // Size address
}
]
}
]
"requestId": "", // Operation request ID
}

13 Get browser security lock status

Basic Information

POST  /api/env/lock/query

Description: Get the locking status of the profile security lock. You need to update MoreLogin client to version 2.14.0 or above.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

envId

integer(int64)

YES

Profile ID

Example of a request

{
"envId": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"envId": 0, // Profile ID
"locked": true // if it had been locked by someone else
},
"requestId": "", // Operation request ID
}

14 Get a list of timezone and language

Basic Information

POST  /api/env/base/list

Description: Get available timezones and languages. You need to update MoreLogin client to version 2.14.0 or above.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

Parameter name

Type

Required

Description

os

integer(int32)

NO

Operating system type

1:Windows,2:macOS,3:Android,4:IOS

Example of a request

{
"os": 0
}

Return data

{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data" {
"language_list": [ // Language list
{
"id": "", // Language ID
"value": "" // Language value
}
],
"time_zone_list": [ // Timezone list
{
"id": "", // Timezone ID
"value": "" // Timezone value
}
]
},
"requestId": "", // Operation request ID
}


How did we do?