API：创建用户视图任务

请联系 Dotcom 监视器支持团队以接收对此 Web API 功能的访问权限。

请求网址

把	https://api.dotcom-monitor.com/config_api_v1/tasks

Request Example

https://api.dotcom-monitor.com/config_api_v1/tasks?Device_Id=328242&Task_Type_Id=21&Timeout=55000&Name=My Script&RequireRepeatVisit=true&WriteVideoOnEachMonitoring=true&DisableHttpProxy=false&DisableVideoRecording=true&DisableScreenshots=true&AbortOnError=true&DNSResolveMode=External DNS Server&DNSserverIP=112.115.124.55&CustomDNSHosts=asa.com=112.115.124.77;cnn.com=112.115.124.78

查询参数

领域类型 必需/可选 描述

超时

int32

自选

包含任务执行超时（以毫秒为单位）。

Device_Id

int32

必填

唯一的设备 ID。

例子：

"Device_Id": 8692

Task_Type_Id

int32

必填

任务的类型。

名字

字符串

自选

任务描述。

要求重复访问

布尔

自选

定义 “模拟回访者 ”标志的状态。

可能的值：

true – 执行监视以模拟已缓存页面元素的频繁访问者。
false – 每次运行都会模拟一个新访客。

写入视频每个监控

布尔

自选

定义“ 每次运行时录制视频 ”选项的状态。

可能的值：

true – 为每个监控会话创建视频记录。
false – 系统在一天中第一个会话中录制错误或从某个位置检测到的第一个错误时录制视频。

DisableHttpProxy

布尔

自选

允许激活代理以通过代理发送监视请求或切换回直接请求。

DisableVideoRecording

布尔

自选

允许禁用视频录制功能。

DisableScreenshots（禁用截图）

布尔

自选

允许禁用屏幕截图功能。

中止错误

布尔

自选

指示是否激活了“首次出错时中止脚本”选项。

可能的值：

true – 脚本执行将在第一个监视错误时停止。
false – 脚本执行将继续，直到达到超时。

DNS 解析模式

布尔

自选

可能的值：

设备缓存
非缓存
TTL 缓存
外部 DNS 服务器

有关详细解释，请参阅 DNS 模式选项文章。

DNSserverIP

字符串

0ptional

自定义 DNS 服务器 IP 地址的字段。有关详细解释，请参阅 DNS 模式选项文章。

CustomDNSHosts

字符串

自选

包含 IP 地址列表 – 用于设置 IP 地址到主机名映射的主机名对。

请求正文

Dotcom 监视器 API 接受使用请求正文上传的二进制文件。要将 ES 脚本与您的请求一起上传到 Dotcom 监视器：

使用每个步骤脚本工具创建或编辑每个步骤脚本。
将脚本下载到您的计算机并保存到 dmuv/dmes 文件。
在 API 客户端中，选择将 dmuv/dmes 文件作为二进制文件发送到请求正文中。如果您的 API 客户端不支持二进制方法，请使用替代方法。

请求示例

curl --location --request PUT "https://api.dotcom-monitor.com/config_api_v1/tasks?Device_Id=16826&Task_Type_Id=21&Timeout=55000&Name=uploaded_dmes_script" ^
--header "Content-Type: application/octet-stream" ^
--header "Cookie: DANA-AUTH-API-COOKIE=7efad88951954e61a1235f43219882f34; DANA-AUTH-COOKIE=21c34cc69cdd4123448eaa5c519a824e" ^
--data "@/C:/Users/dm_admin/ES_Scripts/everystep-script.dmes"

将 ES 脚本作为 base64 编码数据上传

如果您的 API 客户端不支持二进制方法，您可以将 ES 脚本作为 Base64 格式的 JSON 正文参数上传到 Dotcom 监视器。请注意，在这种情况下，所有请求参数都应在请求正文中传递（而不是在查询中传递）。

请求网址

您可以使用 2 种方法将 ES 脚本作为 Base64 上传：

把	https://api.dotcom-monitor.com/config_api_v1/tasks
发布	https://api.dotcom-monitor.com/config_api_v1/tasks?verb=PUT

头参数

Content-Type: application/json

JSON 正文示例

{ 
    "Device_Id": 3153, 
    "Task_Type_Id": 21, 
    "Name": "dotcom-monitor.com", 
    "Timeout": 13, 
    "base64dmuv": "AAEAAAD/////AQAAAAAAAAAEAQAAAAxTeXN0ZW0uSW50MzIBAAAAB21fdmFsdWUACAIAAAALAAEAAAD/////AQAAAAAAAAAMAgAAAERfT1FMX0R5bmFtaWNfLCB.......1bHR1cmU9bmV1dHJh"
    "RequireRepeatVisit": true,
    "WriteVideoOnEachMonitoring": true,
    "DisableHttpProxy": false,
    "DisableVideoRecording": true,
    "DisableScreenshots": true,
    "AbortOnError": true,
    "DNSResolveMode": "External DNS Server",
    "DNSserverIP": "112.115.124.55",
    "CustomDNSHosts": "asa.com=112.115.124.77"
    }

身体参数

下面提供了必需的 JSON 参数。若要向正文添加更多参数，请参阅 API 中的字段说明：UserView 任务 JSON 示例。

领域类型 必需/可选 描述

base64dmuv

字符串

必填

包含 Base64 格式的 ES 脚本。

请参阅将每个步骤脚本转换为 Base64 的指南。

Device_Id

int32

必填

唯一的设备 ID。

例子：

"Device_Id": 8692

Task_Type_Id

int32

必填

任务的类型。

要将脚本转换为 Base64 格式，您需要先将脚本从工具导入到 *.dmuv （ES 桌面）或 *.dmes （ES Web）文件。请按照以下步骤操作：

使用每个步骤脚本工具创建或编辑每个步骤脚本。
将脚本下载到您的计算机并保存到 dmuv/dmes 文件。
使用编码器将 dmuv/dmes 文件转换为 Base64 格式。
将编码的内容复制到 JSON 请求的 base64dmuv 参数中。

或者，如果您在将脚本文件转换为 Base64 时遇到任何问题，可以在此处下载我们的 Base64 编码器。下载后，使用编码器转换 ES 文件，如下所述：

打开命令行并提供编码器.exe文件encoding_checker.exe的路径。
提供下载的 dmuv/dmes 文件的完整路径作为参数（例如，“g：\Temp9\login_check.dmuv”）。
要将转换后的脚本保存到文件中，请提供该文件的路径。

成功响应

示例响应

{
    "Success":true,
    "Result":17989
}

领域	类型	描述
结果	int32	任务的唯一 ID。在 “编辑 ”操作中使用 Id。

[/su_table