認証
Watch-IPは呼び出すエンドポイントに応じて2種類のキーを使い分けます—クライアント側の呼び出し用でブラウザに公開しても安全な公開可能キーと、バックエンド呼び出し専用のシークレットキーです。誤った種類のキーを送信すると401または403が返され、部分的なレスポンスが返ることはありません。
公開可能キー(ブラウザで安全)
GET /v1/geoとPOST /v1/email/validateで使用し、どちらも訪問者のブラウザから直接呼び出せるように設計されています。X-Api-Keyヘッダーとして送信してください(GET /v1/geoはフォールバックとしてkeyクエリパラメータも受け付けます)。これは秘密情報ではありません—ページのJavaScriptに含まれて配信されるものであり、実際に重要なのはキーに設定された許可オリジンのリストで、リクエストのOrigin/Refererヘッダーと照合されます。そのリストにないオリジンからのリクエストは、CORSヘッダーが設定されないまま403を受け取ります—ブラウザはコードがレスポンスを目にする前にそれをブロックします。これがJSONのエラー本文ではなく、実際の強制力です。
公開可能キー
curl https://api.watch-ip.com/v1/geo \
-H "X-Api-Key: YOUR_PUBLISHABLE_KEY"シークレットキー(サーバー専用)
GET /v1/lookup/{ip}、POST /v1/lookup、POST /v1/risk/checkで使用し、いずれもチェックすべきブラウザのOriginを持たないサーバー間エンドポイントです。Authorization: Bearer YOUR_SECRET_KEYとして自分のバックエンドからのみ送信してください—ページやモバイルアプリのバンドル、管理下にないクライアントにシークレットキーを埋め込んではいけません。シークレットキー用のルートで公開可能キーを使用する、またはその逆を行うと403が返されます。
シークレットキー
curl https://api.watch-ip.com/v1/lookup/203.0.113.1 \
-H "Authorization: Bearer YOUR_SECRET_KEY"レート制限
各キーは、ルートごとではなく呼び出すすべてのエンドポイントで共有される、顧客アカウント単位の固定1分間ウィンドウでレート制限されます。制限を超えると429が返されます—レスポンスの形式とバックオフの方法についてはエラーとレート制限をご覧ください。1分あたりのレート制限はアイテム数ではなくHTTP呼び出し数で数えます。最大100件のIPまたはメールアドレスを含むバッチは1リクエストとして数えられ、各アイテムは引き続き月間リクエスト上限に個別に計上されます。
カスタムドメイン
GrowthプランとScaleプランには、ダッシュボードでのカスタムドメイン設定機能が含まれており、api.watch-ip.comの代わりに自分のドメイン上のホスト名にリクエストを送ることができます。利用可否はアカウントの適格性とDNS/SSL設定の成功に依存します—ダッシュボードが有効であることを確認したベースURLに合わせてインテグレーションを設定してください。