クイックスタート
数分でGET /v1/geoの呼び出しを動作させます:キーを作成し、リクエストを送信し、レスポンスを確認します。
始める前に
- Watch-IPアカウント—このガイドには無料プランで十分です。
- fetchやcurlの呼び出しを追加できるページまたはスクリプト。
1. アカウントを作成してキーを取得する
登録してダッシュボードを開いてください。すべてのアカウントには公開可能な訪問者用キーが付属します—呼び出し元のサイト(テスト中はlocalhostでも構いません)を許可オリジンに設定してください。
2. 最初のリクエストを送信する
X-Api-Keyヘッダーに公開可能キーを設定してGET /v1/geoを呼び出します。ブラウザから呼び出すと訪問者自身の接続情報が解決され、サーバーから呼び出すとサーバー自身の接続情報が解決されます。
curl
curl https://api.watch-ip.com/v1/geo \
-H "X-Api-Key: YOUR_PUBLISHABLE_KEY"3. レスポンスを確認する
成功した呼び出しはJSON本文とともに200を返します—country、city、timezoneはほとんどの統合が最初に使用するフィールドで、どのフィールドも個別にnullになる可能性があるため、使用前に確認してください。
レスポンス(抜粋)
{
"ip": "203.0.113.1",
"country": "US",
"city": "Austin",
"timezone": "America/Chicago"
}4. 別のIPをルックアップする
接続元の訪問者ではなく、既に持っているアドレスを解決する必要がありますか?それは公開可能キーではなくシークレットキーで認証する別のサーバー間通信用エンドポイントです—IPルックアップのリファレンスをご覧ください。
問題が発生した場合
401はAPIキーが欠落または無効であることを意味します。GET /v1/geoでの403は通常、呼び出し元のオリジンがそのキーの許可オリジンリストにまだ含まれていないことを意味します。ステータスコードの一覧はエラーとレート制限をご覧ください。
次のステップ
キーの種類とオリジンロックの仕組みについては認証をお読みください。または、統合しようとしているレスポンスについて、直接エンドポイントリファレンスをご覧ください。