IPアドレスをバッチでルックアップする
1つのエンドポイントにIPアドレスのリストを送信し、対応する位置情報結果のリストを受け取ります。Watch-IPのIP一括ルックアップAPIは、バックエンドのエンリッチメント業務向けに、1リクエストにつき最大100件のIPv4・IPv6アドレスを受け付けます。シークレットキーはサーバー上に保管し、レスポンスは入力順に処理し、元のデータとの結びつきを失わずに欠落レコードを処理してください。
1リクエストで最大100件のアドレス
ips配列を含むJSONオブジェクトとともにPOST /v1/lookupを使用してください。受け付けられる各バッチには少なくとも1件、最大100件のアドレスが含まれ、同じリストにIPv4とIPv6を混在させることができます。レスポンスは順序付きのルックアップ結果をresults配列にまとめます。各結果はfoundやnull許容の位置情報フィールドを含む、単体IPルックアップと同じ形式を使用します。
結果を元のレコードと対応させておく
成功したバッチでは、APIは入力アドレスごとに1件の結果を、同じ順序で返します。送信したリストと合わせて自社のレコード識別子を保持しておけば、結果を元の行と結びつけられます。レコードが見つからない場合はその行を保持し、位置情報が利用できないことを示してください。フィールドのみが欠落している場合は、結果の残りの部分を保持してください。欠落した座標をゼロで置き換えないでください—それはデータの欠落を誤解を招く地図上の位置に変えてしまいます。
送信前に検証する
空のリスト、100件を超えるリスト、または不正な形式のIPはリクエストエラーを引き起こします—不正な形式のアドレスは、残りの入力に対する部分的な成功結果を生成するのではなく、バッチ全体を拒否します。入力を検証し、長いリストは送信前にバッチに分割し、リトライによってジョブ全体が誤って繰り返されることのないよう、完了したバッチの記録を保持してください。
バッチ処理が変えるものを理解する
バッチ処理は、リストを送信するために必要なHTTPリクエストの数を減らします。データソースを変えることも、セキュリティフィールドを追加することも、100件のルックアップを1単位の利用量に変えることもありません—ルックアップの利用量は、受け付けられたリクエストで送信されたIPごとに記録されるため、プラン選択の際は総ルックアップ量とリクエストレートの両方を考慮してください。1分あたりのレート制限はアイテム数ではなくHTTP呼び出し数で数えます。最大100件のIPまたはメールアドレスを含むバッチは1リクエストとして数えられ、各アイテムは引き続き月間リクエスト上限に個別に計上されます。
リクエストとレスポンスの形式
- ips
- リクエスト本文:1〜100件のIPv4またはIPv6アドレスのJSON配列。
- results
- レスポンス:入力アドレスごとに1件のエントリを含む、送信順の配列。
- results[].found, results[].country, ...
- 各結果は単体IPルックアップのレスポンスと同じ形式・null許容性を使用します—IPルックアップの製品ページをご覧ください。
バッチリクエストを送信する
cURL — POST /v1/lookup
curl --fail-with-body \
'https://api.watch-ip.com/v1/lookup' \
--header "Authorization: Bearer ${WATCH_IP_SECRET_KEY}" \
--header 'Content-Type: application/json' \
--data '{"ips":["8.8.8.8","2001:4860:4860::8888"]}'これらの例示用アドレスは、特定の現在の位置情報の値を示すものではありません。まずサーバーの環境変数にWATCH_IP_SECRET_KEYを設定してください。
よくある質問
1つのバッチに何件のIPアドレスを含められますか?
現在の上限は100件です。より長いリストは、それぞれ1〜100件のアドレスを含むリクエストに分割してください。
1つのバッチにIPv4とIPv6を混在させられますか?
はい。すべてのアドレスが有効である必要があり、データベースのカバレッジはアドレスによって異なる場合があります。
結果は入力順に返されますか?
はい。成功したバッチは、入力アドレスごとに1件の結果を同じ順序で返します。
1件のIPが不正な形式の場合はどうなりますか?
リクエスト全体が拒否されます。送信前に入力を検証してください—このエンドポイントは不正な形式の入力に対する部分的な成功を提供しません。
1つのバッチは1回のルックアップとして課金されますか?
いいえ。利用量はIPごとに計測されます。大規模なジョブのコストを見積もる前に、現在のルックアップ料金と確認済みの課金例をご確認ください。
CSVファイルをアップロードできますか?
このドキュメントに記載されているエンドポイントは、アドレスのJSON配列を受け付けます。アプリケーション側で独自にCSVを読み込み、バッチを送信することができます—ホスト型のCSVアップロード機能はこのAPIには含まれていません。
一括ルックアップにはVPNやTorのチェックが含まれますか?
いいえ。現在のバルクレスポンスはサードパーティのジオロケーションデータベースの位置情報結果です。訪問者ジオロケーションのセキュリティ指標は、ルックアップのレスポンスには存在しない別の機能です。