リクエストを出す

Postman Collection

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

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

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

新しいリクエストを作成する

POST https://emailverification.whoisxmlapi.com/api/bevService/request

Bulk APIでメールアドレスのリストを確認するには、まずメールアドレスをサーバーにアップロードします。これによりリクエストが作成され、そのIDが返されます。その後、このIDを使用してリクエストのステータスを確認したり、結果をダウンロードしたりすることができます。

APIは、各リクエストの本文にJSON形式でエンコードされたパラメータを受け取ります。

CURLリクエストサンプル

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "emails": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

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

{
    "apiKey": "YOUR_API_KEY",
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

入力パラメータ

apiKey

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

emails

必須。配列。

認証するメールアドレスの配列が含まれます。

format

任意。文字列。

応答の形式を指定するために使用します。

使用可能な値:「xml」、「json」、「csv」。

初期値:「json」。

サンプル出力

{
    "response": {
        "id": 5
    }
}

Code: 200 OK.
{
    "response": {
        "errors": [
            "The format field should have one of the following values: json, xml."
        ]
    }
}

Code: 400 Bad Request.
{
    "response": {
        "error": "Authorisation or authentication failed"
    }
}

Code: 401 Unauthorized.
{
    "response": {
        "error": "Insufficient balance"
    }
}

Code: 402 Payment Required.
response

Responseオブジェクト。

成功時に整数の「id」フィールドを含みます。

エラーが発生した場合は、その説明が「error」フィールドに含まれます。複数のエラーが発生した場合は、それらの説明が「errors」配列で返されます。

id

整数。

新規作成された認証リクエストID。

error

文字列。

エラーの説明。

errors

配列。

複数のエラーメッセージ。