Entre em contato com a equipe de suporte do Dotcom-Monitor para receber acesso a essa funcionalidade da API da Web.

Solicitar URL

Postar https://api.dotcom-monitor.com/config_api_v1/task/{task_id}

Parâmetros do caminho

campo Type Necessário descrição
task_id

corda

true

A ID exclusiva de uma tarefa de monitoramento que você deseja editar.

Para ver uma ID de tarefa na sua conta dotcom-monitor, abra o dispositivo de destino na lista Gerenciador de dispositivos a ser editado. Na barra de endereços do navegador você verá algo como:

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

O taskId=132834 é o id da tarefa.

Parâmetros de consulta

campo Type Exigido/Opcional descrição
timeout

int32

opcional

Contém o tempo limite de execução da tarefa em ms.
Device_Id

int32

Necessário

O id exclusivo do dispositivo.

exemplo:
"Device_Id": 8692
Task_Type_Id

int32

Necessário

O tipo de tarefa.
nome

corda

opcional

A descrição da tarefa.
RequireRepeatVisit

booleano

opcional

Define o estado do sinalizador Simular Visitante de Retorno .

VALORES POSSÍVEIS:

  • true – o monitoramento é executado para simular um visitante frequente que já tem elementos da página armazenados em cache.
  • false – um novo visitante é simulado para cada corrida.
WriteVideoOnEachMonitoring

booleano

opcional

Define o estado da opção Gravar vídeo em cada execução .

POSSIBLE VALUES:

  • true – um registro de vídeo é criado para cada sessão de monitoramento.
  • false – o sistema grava um vídeo na primeira sessão de um dia que erros ou no primeiro erro detectado de um local.
DisableHttpProxy

booleano

opcional

Permite ativar a opção de proxy para enviar solicitações de monitoramento através de um proxy ou voltar para solicitações diretas.
DesativarGravação de Vídeo

booleano

opcional

Permite desativar o recurso de gravação de vídeo.
DisableScreenshots

booleano

opcional

Permite desativar o recurso de capturas de tela.
AbortOnError

booleano

opcional

Indica se a opção Abortar script no primeiro erro está ativada.

VALORES POSSÍVEIS:

  • true – a execução do script será interrompida no primeiro erro de monitoramento.
  • false – a execução do script continuará até que o tempo limite seja atingido.
DNSResolveMode

booleano

opcional

VALORES POSSÍVEIS:

  • Cacheado do dispositivo
  • Não armazenado em cache
  • TTL Cached
  • Servidor DNS externo

Para obter uma explicação detalhada, consulte o artigo DNS Mode Option.

DNSserverIP

corda

0ptional

O campo para um endereço IP de servidor DNS personalizado. Para obter uma explicação detalhada, consulte o artigo DNS Mode Option.
CustomDNSHosts

corda

opcional

Contém a lista de endereços IP – pares de nomes de host que são usados para configurar o mapeamento de endereços IP para nomes de host.

Corpo do Pedido

A API Dotcom-Monitor aceita arquivos binários carregados com um corpo de solicitação. Para carregar um script ES junto com sua solicitação para o Dotcom-Monitor:

  1. Crie ou edite um script EveryStep usando a EveryStep Scripting Tool.
  2. Baixe o script para o seu computador e salve em um arquivo dmuv/dmes.
  3. Em um cliente de API, selecione para enviar o arquivo dmuv/dmes como um arquivo binário no corpo da solicitação. Se o cliente de API não oferecer suporte ao método binário, use uma abordagem alternativa.
Exemplo de solicitação
curl --location --request PUT "https://api.dotcom-monitor.com/config_api_v1/task/12365?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"

Carregando o script ES como dados codificados em Base64

Se o cliente de API não oferecer suporte ao método binário, você poderá carregar o script ES no Dotcom-Monitor como um parâmetro de corpo JSON no formato Base64. Observe que, nesse caso, todos os parâmetros de solicitação devem ser passados no corpo da solicitação (não na consulta).

Solicitar URL

Postar https://api.dotcom-monitor.com/config_api_v1/task/{task_id}

Parâmetros do caminho

campo Type Necessário descrição
task_id

corda

true

A ID exclusiva de uma tarefa de monitoramento que você deseja editar.

Parâmetros de cabeçalho

Content-Type: application/json

Exemplo de corpo JSON

{ 
    "Device_Id": 3153, 
    "Task_Type_Id": 21, 
    "Name": "dotcom-monitor.com", 
    "Timeout": 1200, 
    "base64dmuv": "AAEAAAD/////AQAAAAAAAAAEAQAAAAxTeXN0ZW0uSW50MzIBAAAAB21fdmFsdWUACAIAAAALAAEAAAD/////AQAAAAAAAAAMAgAAAERfT1FMX0R5bmFtaWNfLCB.......1bHR1cmU9bmV1dHJh"
    
}

Parâmetros do corpo

Os parâmetros JSON necessários são fornecidos abaixo. Para adicionar mais parâmetros ao corpo, consulte a descrição dos campos na API: UserView Task JSON Sample.

campo Type Exigido/Opcional descrição
base64dmuv corda Necessário Contém script ES no formato Base64.

Consulte a diretriz para converter o script EveryStep em Base64.

Device_Id

int32

Necessário

O id exclusivo do dispositivo.

exemplo:
"Device_Id": 8692
Task_Type_Id

int32

Necessário

O tipo de tarefa.

Para converter o script para o formato Base64, você precisará importar o script da ferramenta para um arquivo *.dmuv (ES Desktop) ou *.dmes (ES Web) primeiro. Por favor, siga os passos abaixo:

  1. Crie ou edite um script EveryStep usando a EveryStep Scripting Tool.
  2. Baixe o script para o seu computador e salve em um arquivo dmuv/dmes.
  3. Use um codificador para converter o arquivo dmuv/dmes no formato Base64.
  4. Copie um conteúdo codificado para o parâmetro base64dmuv de sua solicitação JSON.

Alternativamente, se você tiver qualquer problema para converter o arquivo de script em Base64, você pode baixar nosso codificador Base64 aqui. Uma vez baixado, use o codificador para converter o arquivo ES conforme descrito abaixo:

  1. Abra a linha de comando e forneça um caminho para o codificador .exe encoding_checker.exe de arquivo .
  2. Forneça o caminho completo para o arquivo dmuv/dmes baixado como um argumento (por exemplo, “g:\Temp9\login_check.dmuv”).
  3. Para salvar um script convertido em um arquivo, forneça um caminho para o arquivo.

Resposta de sucesso

Resposta de exemplo
{
    "Success": true,
    "Result": "Task 12365 has been updated"
}