Contactez l’équipe de support Dotcom-Monitor pour accéder à cette fonctionnalité de l’API Web.

URL de la demande

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

Paramètres de chemin d’accès

champ Type Obligatoire description
task_id

corde

true

ID unique d’une tâche de surveillance que vous souhaitez modifier.

Pour afficher un ID de tâche à partir de votre compte dotcom-monitor, ouvrez l’appareil cible dans la liste Gestionnaire de périphériques à modifier. Dans la barre d’adresse du navigateur, vous verrez quelque chose comme :

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

taskId=132834 est l’ID de tâche.

Paramètres de requête

champ Type Obligatoire/Facultatif description
Timeout

int32 (en)

optionnel

Contient le délai d’exécution des tâches en ms.
Device_Id

int32 (en)

Obligatoire

ID d’appareil unique.

exemple:
"Device_Id": 8692
Task_Type_Id

int32 (en)

Obligatoire

Type de tâche.
nom

corde

optionnel

Description de la tâche.
RequireRepeatVisit

booléen

optionnel

Définit l’état de l’indicateur Simuler le visiteur récurrent .

VALEURS POSSIBLES :

  • true : la surveillance est exécutée pour simuler un visiteur fréquent qui a déjà mis en cache des éléments de la page.
  • false : un nouveau visiteur est simulé pour chaque exécution.
WriteVideoOnEachMonitoring

booléen

optionnel

Définit l’état de l’option Enregistrer la vidéo à chaque exécution .

VALEURS POSSIBLES :

  • true : un enregistrement vidéo est créé pour chaque session de surveillance.
  • false – Le système enregistre une vidéo lors de la première session d’une journée qui génère des erreurs ou lors de la première erreur détectée à partir d’un emplacement.
DisableHttpProxy

booléen

optionnel

Permet d’activer l’option proxy pour envoyer des requêtes de surveillance via un proxy ou revenir aux requêtes directes.
DésactiverEnregistrement vidéo

booléen

optionnel

Permet de désactiver la fonction d’enregistrement vidéo.
DésactiverCaptures d’écran

booléen

optionnel

Permet de désactiver la fonction de captures d’écran.
AbortOnError

booléen

optionnel

Indique si l’option Abandonner le script en cas de première erreur est activée.

VALEURS POSSIBLES :

  • true : l’exécution du script sera arrêtée à la première erreur de surveillance.
  • false – L’exécution du script se poursuivra jusqu’à ce que le délai d’expiration soit atteint.
DNSResolveMode

booléen

optionnel

VALEURS POSSIBLES :

  • Dispositif mis en cache
  • Non mis en cache
  • TTL Mis en cache
  • Serveur DNS externe

Pour plus d’informations, consultez l’article Option de mode DNS.

DNSserverIP (en)

corde

0ptionnel

Champ d’une adresse IP de serveur DNS personnalisée. Pour plus d’informations, consultez l’article Option de mode DNS.
CustomDNSHosts

corde

optionnel

Contient la liste des paires adresse IP-nom d’hôte utilisées pour configurer le mappage des adresses IP aux noms d’hôte.

Corps de la demande

L’API Dotcom-Monitor accepte les fichiers binaires téléchargés avec un corps de requête. Pour télécharger un script ES avec votre demande sur Dotcom-Monitor :

  1. Créez ou modifiez un script EveryStep à l’aide de l’outil de script EveryStep.
  2. Téléchargez le script sur votre ordinateur et enregistrez-le dans un fichier dmuv/dmes.
  3. Dans un client API, sélectionnez pour envoyer le fichier dmuv/dmes en tant que fichier binaire dans le corps de la demande. Si votre client API ne prend pas en charge la méthode binaire, utilisez une autre approche.
Exemple de demande
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"

Téléchargement du script ES en tant que données codées en Base64

Si votre client API ne prend pas en charge la méthode binaire, vous pouvez télécharger votre script ES sur Dotcom-Monitor en tant que paramètre de corps JSON au format Base64. Notez que dans ce cas, tous les paramètres de la demande doivent être passés dans le corps de la demande (et non dans la requête).

URL de la demande

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

Paramètres de chemin d’accès

champ Type Obligatoire description
task_id

corde

true

ID unique d’une tâche de surveillance que vous souhaitez modifier.

Paramètres d’en-tête

Content-Type: application/json

Exemple de corps JSON

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

Paramètres du corps

Les paramètres JSON requis sont fournis ci-dessous. Pour ajouter d’autres paramètres au corps, consultez la description des champs dans l’API : UserView Task JSON Sample.

champ Type Obligatoire/Facultatif description
base64dmuv corde Obligatoire Contient le script ES au format Base64.

Veuillez consulter les instructions pour convertir le script EveryStep en Base64.

Device_Id

int32 (en)

Obligatoire

ID d’appareil unique.

exemple:
"Device_Id": 8692
Task_Type_Id

int32 (en)

Obligatoire

Type de tâche.

Pour convertir le script au format Base64, vous devez d’abord importer le script de l’outil dans un fichier *.dmuv (ES Desktop) ou *.dmes (ES Web). Veuillez suivre les étapes ci-dessous :

  1. Créez ou modifiez un script EveryStep à l’aide de l’outil de script EveryStep.
  2. Téléchargez le script sur votre ordinateur et enregistrez-le dans un fichier dmuv/dmes.
  3. Utilisez un encodeur pour convertir le fichier dmuv/dmes au format Base64.
  4. Copiez un contenu codé dans le paramètre base64dmuv de votre requête JSON.

Alternativement, si vous avez des difficultés à convertir le fichier de script en Base64, vous pouvez télécharger notre encodeur Base64 ici. Une fois téléchargé, utilisez l’encodeur pour convertir le fichier ES comme décrit ci-dessous:

  1. Ouvrez la ligne de commande et indiquez un chemin d’accès à l’encodeur .exe au fichier encoding_checker.exe.
  2. Fournissez le chemin d’accès complet au fichier dmuv/dmes téléchargé en tant qu’argument (par exemple, « g:\Temp9\login_check.dmuv »).
  3. Pour enregistrer un script converti dans un fichier, indiquez un chemin d’accès au fichier.

Réponse au succès

Exemple de réponse
{
    "Success": true,
    "Result": "Task 12365 has been updated"
}