Usage Overview

When the interface request method is POST, the parameter passing method is always body parameter passing, passing data in JSON format, not form-data, nor URL parameter passing
When the interface request method is get, the parameter passing is form-data
The interface request method is put/patch/delete. For specific parameter passing, refer to the definition in the interface documentation.
When the interface request returns 200 successfully, it returns a json object, with code 0 indicating success. If there is return data, it is appended to the data object.
When the interface does not return 200, it is considered an exception. Refer to HTTP error codes for exception codes. When the code is not 0, it indicates failure, and failure information will be appended to the msg field. Refer to the following table for the error code field.
All requests need to include the request header:X-HTTP-KEY, whose value is the secret key copied from the [Open Api - Http API] interface of DICloak software.

Profile Interface

GET Obtain profile List

GET /v1/api/request/{env_id}/open

Request Parameters

Name	Type	Required	Instructions
page_no	integer	Yes	Page number, default 1
page_size	integer	Yes	Page size, default 10
serial_num	integer	No	Serial Number
name	string	No	Name
group_id	string	No	Grouping
proxy_host	string	No	Proxy Host (Method 1)
status	string	No	Status (DISABLED: Disabled, ENABLED: Normal)
platform_user	string	No	Platform
remark	string	No	Remarks
start_create_time	string	No	Start Time
end_create_time	string	No	End Time
operate_status	string	No	profile Open Status: ENABLED for Open, DISABLED for Closed

Response Parameters

Name	Type	Instructions
id	string	profile ID, env_id
create_time	string	Creation Time
update_time	string	Modification Time
serial_num	integer	Serial Number
group_id	string	Group ID
group_name	string	Group Name
name	string	Name
browser	string	Browser Type (CHROME: Chrome)
ua_type	string	ua type
ua	string	User Agent
ua_os	string	User Agent OS WINDOWS/MAC/ANDROID/IOS/LINUX
cookie	string	cookie
other_cookie	string	Other cookies
proxy_way	string	Proxy Mode (CUSTOM: Custom SELECT_EXIST: Select Existing)
proxy_id	string	Agent ID (Method 2)
proxy_type	string	Proxy Type (Method 1) (NON_USE: Do not use HTTP HTTPS SSH SOCKS5 IPFLY)
proxy_host	string	Proxy Host (Method 1)
proxy_port	integer(int32)	Proxy Port (Method 1)
proxy_user_name	string	Proxy Account (Method 1)
proxy_passwd	string	Proxy Password (Method 1)
proxy_ip_type	string	IP Query Channel (Method 1) (IP2LOCATION)
urls	[string]	URL List
config	string	Advanced Settings JSON
status	string	Status (DISABLED: Disabled, ENABLED: Normal)
remark	string	Remarks
last_open_time	string	Last Opened Time
operate_status	string	Operating Status DISABLED Closed ENABLED Enabled LOCK Locked
account_list	[object]	Account
font_id	string	Font ID
data_config	string	Data Configuration
browser_config	string	Browser Configuration
env_mutil_open_type	string	profile Multi-Opening: GLOBAL: Global ALLOW: Allow BAN: Ban
operate_members	[object]	Current profile Operator Information
config_ext_map	object	Extended Field
total	integer(int32)	Total number of items

Response Example

{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": "1848687666096832515",
                "create_time": "2024-10-22 19:27:41",
                "update_time": "2024-10-23 21:28:15",
                "serial_num": 166,
                "group_id": "1776895967565094913",
                "group_name": null,
                "name": "env——name",
                "browser": "CHROME",
                "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.6005.0 Safari/537.36",
                "ua_os": "MAC",
                "cookie": "",
                "other_cookie": null,
                "urls": [
                    
                ],
                "status": "ENABLED",
                "remark": null,
                "last_open_time": "2024-10-23 21:26:15",
                "operate_status": "DISABLED",
                "account_list": null,
                "font_id": "",
                "data_config": "{\"type\":25,\"dataType\":\"custom\"}",
                "browser_config": "{\"type\":1,\"browserType\":\"custom\"}",
                "env_mutil_open_type": "GLOBAL",
                "config_ext_map": null
            }
        ],
        "total": 65
    }
}

POST Add profile

POST /v1/api/request

Request Parameters

Name	Type	Required	Instructions
group_id	string	Yes	Group ID
name	string	No	Name
browser	string	Yes	Browser Type (CHROME: Chrome)
kernel_version	string	No	Kernel version 120 (default), 134
os	OsVO	Yes	Operating System
ua_type	string	Yes	ua Type (see Appendix ua Type)
ua	string	Yes	User Agent
ua_os	string	Yes	Ua OS WINDOWS/LINUX/MAC/ANDROID/IOS
cookie	string	No	cookie
other_cookie	string	No	Other cookies
proxy_way	string	No	Proxy Mode (CUSTOM: Custom SELECT_EXIST: Select Existing)
proxy_id	string	No	Agent ID (Method 2)
proxy_type	string	No	Proxy Type (Method 1) (NON_USE: Do not use HTTP HTTPS SSH SOCKS5 IPFLY)
proxy_host	string	No	Proxy Host
proxy_port	integer(int32)	No	Proxy Port
proxy_user_name	string	No	Agent Account
proxy_passwd	string	No	Proxy Password
proxy_ip_type	string	No	IP Query Channel (IP2LOCATION)
urls	[string]	No	URL List
config	string	Yes	Advanced Settings JSON (see attached table: Advanced profile Settings)
remark	string	No	Remarks
data_config	string	No	Data Configuration (Appendix: Data Synchronization)
browser_config	string	No	Browser Configuration (Appendix: Browser Configuration)
config_ext_map	object	No	Extended Field
env_mutil_open_type	string	No	profile Multi-Opening: (GLOBAL: Global ALLOW: Allow BAN: Ban)
extensions_type	string	No	Extended Configuration: (ALLOW: Allow BAN: Ban)
extensions_group_id	string	No	Extended Group ID
account_list	[profileAccount]	No	Account

profileAccount

Name	Type	Required	Instructions
platform	string	Yes	Platform
url	string	Yes	url
user_name	string	No	Log in to the account
passwd	string	No	Login Password
secret	string	No	Key
remark	string	No	Account Remarks

{
    "extensions_type": "ALLOW",
    "name": "测试环境",
    "group_id": "1858448274955902978",
    "browser": "CHROME",
    "os": {
        "windows": [
            "windows-all"
        ],
        "mac": [
            
        ],
        "android": [
            
        ],
        "ios": [
            
        ],
        "linux": [
            
        ]
    },
    "ua_type": "[\"all\"]",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.6166.0 Safari/537.36",
    "proxy_way": "CUSTOM",
    "proxy_type": "NON_USE",
    "proxy_ip_type": "IPAPI",
    "account_list": [
        
    ],
    "urls": [
        
    ],
    "config": "{\"acceptLangType\":\"ip\",\"acceptLangValue\":[\"en-US\",\"en\"],\"langType\":\"acceptLang\",\"langValue\":\"local\",\"timezoneType\":\"ip\",\"timezoneValue\":\"local\",\"geoType\":\"ask\",\"geoSubType\":\"ip\",\"geoValue\":{},\"fontType\":\"custom\",\"fontValue\":[\"Academy Engraved LET\",\"Yrsa SemiBold\",\"Yu Gothic UI\",\"Yu Gothic UI Regular\",\"Z003\"],\"webrtcType\":\"disable\",\"webrtcValue\":\"\",\"canvasType\":\"noise\",\"canvasValue\":\"42541\",\"ratioType\":\"truth\",\"ratioValue\":\"\",\"webGLImageType\":\"noise\",\"webGLImageValue\":\"92132\",\"webGLMetadataType\":\"custom\",\"webglManufacturer\":\"Google Inc. (AMD)\",\"webglRender\":\"ANGLE (AMD, Radeon RX 580 Series Direct3D11 vs_5_0 ps_5_0, D3D11-31.0.14051.5006)\",\"webGPUType\":\"disable\",\"audioContextType\":\"noise\",\"audioContextValue\":91094,\"clientRectsType\":\"noise\",\"clientRectsValue\":3530,\"speechVoicesType\":\"noise\",\"speechVoicesValue\":10408,\"deviceMemoryValue\":\"8\",\"trackType\":\"0\",\"batteryType\":\"noise\",\"batteryValue\":62582,\"portType\":\"1\",\"portValue\":\"\",\"accelerateType\":\"0\",\"hardwareConcurrencyValue\":\"12\",\"ratioWidth\":\"\"}",
    "data_type": "global",
    "browser_type": "global",
    "env_mutil_open_type": "GLOBAL",
    "ua_os": "WINDOWS",
    "extensions_group_id": "1858448274955902979",
    "data_config": "{\"type\":0,\"dataType\":\"global\"}",
    "browser_config": "{\"type\":0,\"browserType\":\"global\"}"
}

Response Parameters

Name	Type	Instructions
id	string	Unique ID of the profile
serial_number	integer	profile Number
Other same request parameters	string	profile Details (Refer to Request Parameter Definitions)

{
    "code": 0,
    "msg": "成功",
    "data": {
        "id": "1864934151789899778",
        "serial_num": 1,
        "extensions_type": "ALLOW",
        "name": "测试环境",
        "group_id": "1858448274955902978",
        "browser": "CHROME",
        "os": {
            "windows": [
                "windows-all"
            ],
            "mac": [
                
            ],
            "android": [
                
            ],
            "ios": [
                
            ],
            "linux": [
                
            ]
        },
        "ua_type": "[\"all\"]",
        "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.6166.0 Safari/537.36",
        "proxy_way": "CUSTOM",
        "proxy_type": "NON_USE",
        "proxy_ip_type": "IPAPI",
        "account_list": [
            
        ],
        "urls": [
            
        ],
        "config": "{\"acceptLangType\":\"ip\",\"acceptLangValue\":[\"en-US\",\"en\"],\"langType\":\"acceptLang\",\"langValue\":\"local\",\"timezoneType\":\"ip\",\"timezoneValue\":\"local\",\"geoType\":\"ask\",\"geoSubType\":\"ip\",\"geoValue\":{},\"fontType\":\"custom\",\"fontValue\":[\"Academy Engraved LET\",\"Yrsa SemiBold\",\"Yu Gothic UI\",\"Yu Gothic UI Regular\",\"Z003\"],\"webrtcType\":\"disable\",\"webrtcValue\":\"\",\"canvasType\":\"noise\",\"canvasValue\":\"42541\",\"ratioType\":\"truth\",\"ratioValue\":\"\",\"webGLImageType\":\"noise\",\"webGLImageValue\":\"92132\",\"webGLMetadataType\":\"custom\",\"webglManufacturer\":\"Google Inc. (AMD)\",\"webglRender\":\"ANGLE (AMD, Radeon RX 580 Series Direct3D11 vs_5_0 ps_5_0, D3D11-31.0.14051.5006)\",\"webGPUType\":\"disable\",\"audioContextType\":\"noise\",\"audioContextValue\":91094,\"clientRectsType\":\"noise\",\"clientRectsValue\":3530,\"speechVoicesType\":\"noise\",\"speechVoicesValue\":10408,\"deviceMemoryValue\":\"8\",\"trackType\":\"0\",\"batteryType\":\"noise\",\"batteryValue\":62582,\"portType\":\"1\",\"portValue\":\"\",\"accelerateType\":\"0\",\"hardwareConcurrencyValue\":\"12\",\"ratioWidth\":\"\"}",
        "data_type": "global",
        "browser_type": "global",
        "env_mutil_open_type": "GLOBAL",
        "ua_os": "WINDOWS",
        "extensions_group_id": "1858448274955902979",
        "data_config": "{\"type\":0,\"dataType\":\"global\"}",
        "browser_config": "{\"type\":0,\"browserType\":\"global\"}"
    },
    "next": null
}

PUT Edit profile

PUT /v1/api/request/{env_id}

Request Parameters

Name	Type	Required	Instructions
env_id	string	Yes	Unique ID of the profile
Other request parameters	string	Yes	Refer toNew profileRequest parameter definition. If a field is not passed, the update will be ignored

Response Parameters

{
    'code': 0,
    'msg': 'success'
}

DELETE Delete profile

DELETE /v1/api/request/{env_id}

Request Parameters

Name	Type	Required	Instructions
env_id	string	Yes	Unique ID of the profile

Response Parameters

{
    'code': 0,
    'msg': 'success'
}

DELETE Completely delete the profile

DELETE /v1/api/request/{env_id}/thorough

Request Parameters

Name	Type	Required	Instructions
env_id	string	Yes	Unique ID of the profile

Response Parameters

{
    'code': 0,
    'msg': 'success'
}

DICloak Help Center

Http API-Development Documentation

Profile Interface

GET Obtain profile List

Request Parameters

Response Parameters

POST Add profile

Request Parameters

Response Parameters

PUT Edit profile

Request Parameters

Response Parameters

DELETE Delete profile

Request Parameters

Response Parameters

DELETE Completely delete the profile

Request Parameters

Response Parameters