リクエストを出す | ドキュメント | Brand Alert API | WhoisXML API

リクエストを出す

APIエンドポイント

POST https://brand-alert.whoisxmlapi.com/api/v2
アカウントの登録後、有効化に最大1分かかります。

Postman Collection

Postmanは、GUIからAPIへのリクエストを可能にするデスクトップおよびウェブのアプリケーションです。APIの機能を活用する際、およびアプリケーションのトラブルシューティングにあたっては、PostmanとWhoisXML APIエンドポイントのご利用をお勧めします。

WhoisXML API Postman Collectionは、以下のリンクから入手できます:

コレクションの環境はあらかじめ設定されたものです。各リクエストを起動するためには、api_key変数を設定する必要があります。個人用API KEYは、My productsページで取得してください。APIに関するご質問は、こちらにお送りください。

POSTリクエストボディのサンプル

{
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2024-02-23",
    "mode": "purchase",
    "withTypos": false,
    "responseFormat": "json",
    "punycode": true,
    "includeSearchTerms": [
        "google",
        "blog"
    ],
    "excludeSearchTerms": [
        "analytics"
    ]
}

ヘッダー

X-Authentication-Token

APIコールには、このヘッダーまたはapiKeyパラメータを使用できます。

My productsページでAPI KEYを取得してください。

入力パラメータ

apiKey

必須My productsページでAPI KEYを取得してください。

includeSearchTerms

必須。検索語の配列。全てドメイン名に含まれている必要があります。最大4項目。大文字/小文字を区別しません

excludeSearchTerms

任意。検索語の配列。全てドメイン名の中に存在してはなりません。最大4項目。大文字/小文字を区別しません。

sinceDate

任意。「YYYY-MM-DD」形式の日付。

許容される日付は、[今日マイナス14日 - 今日] の期間に含まれます。

デフォルトは昨日の日付。

なお、昨日の結果は通常午前10-12時(UTC)に発表される。

存在する場合、指定された日付以降に発見された活動を検索します。実際の追加日/更新日/失効日と、システムが変更を検出した日付の間に遅れが生じることがあります。毎日の変更をフィルタリングするために、監視ツールでこのフィールドを使用することをお勧めします。

mode

任意

preview- ドメイン数のみを返します。クレジットは差し引かれません。

purchase- ドメイン名の実際のリストを返します(10,000個まで)。1リクエストにつき10 DRSクレジットが必要です。

利用可能な値:previewpurchase

初期値:preview

withTypos

任意trueを指定すると、検索語のタイプミスが強調されます。例えば「google」という単語の場合、タイポは以下のようになります:「goigle」、「gokgle」、「golgle」、「gopgle」、「gogglee」、「gooogle」など。

利用可能な値:falsetrue

初期値:false

タイポを含む - リクエスト1件につき300 DRSクレジット

さらに詳しく:Typo generation FAQ

punycode

任意trueの場合、応答のドメイン名はPunycodeにエンコードされます。

利用可能な値:falsetrue

初期値:true

responseFormat

任意。応答の出力形式。

利用可能な値:json|xml

初期値:json

無料アクセス

アカウントの登録後、最大500 DRSクレジットが無料になるサブスクリプションプランが自動的に適用されます。

使用量の上限とリクエストのスロットリング

1秒あたりのリクエスト数の上限は30件です。この上限を超えた場合、 次のまでリクエストは拒否されます。

プレミアムAPIサービスおよびエンタープライズAPIパッケージでご提供するAPIでは、専用のロードバランサーとプレミアムエンドポイントにより、さらに高速なクエリが可能です。