ドットコムモニターのサポートチームに連絡して、このWeb API機能へのアクセスを受け取ります。

URL をリクエストする

置く 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(英語)

ブーリアン

随意

プロキシをアクティブ化して、プロキシ経由で監視要求を送信したり、直接要求に切り替えたりできます。
ビデオ録画の無効化

ブーリアン

随意

ビデオ録画機能を無効にできます。
DisableScreenshots

ブーリアン

随意

スクリーンショット機能を無効にできます。
中止時エラー

ブーリアン

随意

[最初のエラー時にスクリプトを中止する] オプションがアクティブになっているかどうかを示します

指定できる値:

  • true – スクリプトの実行は、最初の監視エラーで停止します。
  • false – スクリプトの実行はタイムアウトに達するまで続行されます。
モードを変更します。

ブーリアン

随意

指定できる値:

  • デバイスキャッシュ
  • キャッシュなし
  • TTL キャッシュ
  • 外部 DNS サーバー

詳細については 、DNS モード オプション の記事を参照してください。

ド・スサーバーIP

0ptional

カスタム DNS サーバーの IP アドレスのフィールド。 詳細については 、DNS モード オプション の記事を参照してください。
カスタムDNSホスト

随意

IP アドレスからホスト名へのマッピングを設定するために使用される IP アドレスとホスト名のペアのリストが含まれます。

要求本文

ドットコムモニター API は、要求本文でアップロードされたバイナリ ファイルを受け入れます。 ES スクリプトを要求と共にドットコムモニターにアップロードするには:

  1. EveryStep スクリプト ツールを使用して EveryStep スクリプトを作成または編集します。
  2. スクリプトをコンピューターにダウンロードし、dmuv/dmes ファイルに保存します。
  3. 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 本文パラメーターとしてドットコム モニターにアップロードできます。 この場合、すべての要求パラメーターは (クエリではなく) 要求本文で渡す必要があることに注意してください。

URL をリクエストする

ES スクリプトを Base64 としてアップロードするには、次の 2 つの方法があります。

置く 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 サンプル」のフィールドの説明を参照してください。

種類 必須/オプション 形容
ベース64DMUV 必須 Base64 形式の ES スクリプトが含まれています。

EveryStep スクリプトを Base64 に変換するための ガイドライン を参照してください。

Device_Id

int32

必須

一意のデバイス ID。

例:
"Device_Id": 8692
Task_Type_Id

int32

必須

タスクの種類。

スクリプトを Base64 形式に変換するには、まずツールから *.dmuv (ES デスクトップ) または *.dmes (ES Web) ファイルにスクリプトをインポートする必要があります。以下の手順に従ってください。

  1. EveryStep スクリプト ツールを使用して EveryStep スクリプトを作成または編集します。
  2. スクリプトをコンピューターにダウンロードし、dmuv/dmes ファイルに保存します。
  3. エンコーダーを使用して、dmuv/dmes ファイルを Base64 形式に変換します。
  4. エンコードされたコンテンツを JSON 要求の base64dmuv パラメーターにコピーします。

または、スクリプトファイルをBase64に変換する際に問題が発生した場合は、 ここからBase64エンコーダーをダウンロードできます。 ダウンロードしたら、エンコーダーを使用して、以下に説明するようにESファイルを変換します。

  1. コマンド ラインを開き、エンコーダー .exe ファイル encoding_checker.exeへのパスを指定します
  2. ダウンロードした dmuv/dmes ファイルへのフル パスを引数として指定します (例: “g:\Temp9\login_check.dmuv”)。
  3. 変換されたスクリプトをファイルに保存するには、ファイルへのパスを指定します。

成功の応答

応答の例
{
    "Success":true,
    "Result":17989
}

種類

形容

結果

int32

タスクの一意の ID。 編集操作で ID を使用します。
[/su_table