ルックアップ
IPジオロケーションAPI
CleariflowのIPジオロケーションAPIは、190か国以上のIPアドレスの位置情報と詳細データを特定する、高速・効率的・モダンなRESTful JSON APIです。
GET
IPジオロケーションAPI
APIの操作は非常にシンプルです。APIキーとIPアドレスを指定するだけで、郵便番号、都市名、地域情報、国の詳細、正確な緯度/経度座標を含む包括的な位置データが返されます。
これは成功したリクエストを表し、以下にIPアドレスと関連する詳細が返されます。
レスポンスは次のようになります。
訪問者からジオロケーションとその他のデータを取得するために必要なのはこれだけです!必須パラメータは固有のAPIキーのみです。
はじめに
RESTアーキテクチャ
CleariflowのすべてのAPIと同様、IPジオロケーションAPIはRESTの原則に従います。予測可能なリソース指向のURLを採用し、エラー表示にHTTPステータスコードを使用します。HTTPSセキュリティ
IPジオロケーションAPIとのすべての通信は、TLS 1.2以上のプロトコルで保護する必要があります。APIバージョン管理
CleariflowのすべてのAPIにはバージョン管理が組み込まれています。IPジオロケーションAPIは現在バージョン1で稼働しています。APIキーによる認証
APIキーは、Cleariflow IPジオロケーションAPIにアクセスするための固有の認証情報です。Cleariflowの各APIには固有のAPIキーが必要であり、IPジオロケーションとメール検証APIなど異なるサービスでは別々のキーが必要です。リクエストを認証するには、ベースURLにAPIキーを付加してください。ベースURL
ジオロケーションエンドポイント
Cleariflow IPジオロケーションAPIでは、固有のAPIキーのみが必要で、リクエスト元クライアントのIPアドレスを自動的に検出します。または、“ip_address” パラメータを含めて分析対象の特定のIPを指定できます。リクエストパラメータ
固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、IPジオロケーションAPIのキーはメール検証APIなどでは動作しません。
ジオロケーション対象のIPアドレスです。IPv4とIPv6の両方をサポートしています。このパラメータを空白のままにすると、リクエストが送信されたIPアドレスをジオロケーションします。
返す トップレベル キーのカンマ区切りリストです(例:
?fields=country,security)。VPN/プロキシフラグを含めるには security を使用します。オブジェクト全体が返されます(存在する場合は is_vpn、is_proxy、vpn_provider)。is_vpn 単体のようなネストされたキーはサポートされていません。レスポンスパラメータ
APIレスポンスは、汎用的で軽量な JSON形式 で返されます。ジオロケーションのために送信されたIPアドレスです。
都市名です。
都市のgeoname IDです。
都市が所在する州または県です。
州または県のISO 3166-2コードです。
州または県のgeoname IDです。
ZIPまたは郵便番号です。
国名です。
国のISO 3166-1 alpha-2コードです。
国のgeoname IDです。
国がEUに属する場合に true、そうでない場合に false です。
大陸名です。
2文字の大陸コード:AF、AS、EU、NA、OC、SA、AN。
大陸のgeoname IDです。
経度の小数値です。
緯度の小数値です。
IPが列挙型VPN出口ノードデータベース(IP-to-VPN MMDB)に一致する場合に
true です。IPがプロキシデータベース(IP-to-VPN MMDB)に一致する場合に
true です。MMDBからのVPNサービス名です(例:
NordVPN)。is_vpn が false の場合は省略されます。IANAタイムゾーンデータベースからのタイムゾーン名です。
IANAタイムゾーンデータベースからのタイムゾーン略称です。
グリニッジ標準時(GMT)からのタイムゾーンオフセットです。
ローカルタイムゾーンの現在時刻です。
現在地が現在サマータイム(DST)中の場合に true です。
SVG形式の国旗のホスト版へのリンクです。
PNG形式の国旗のホスト版へのリンクです。
絵文字としての国旗です。
Unicode形式の国旗です。
通貨名です。
ISO 4217形式の通貨コードです。
ASN組織名から推測されます(例:Cellular、Cable/DSL、Corporate、Cloud、Hosting)。VPNとプロキシはここではなく
security で報告されます。自律システム番号です。
自律システム組織名です。
インターネットサービスプロバイダー(ISP)名です。
組織名です。
レスポンスフィールドの制限
JSONレスポンスから一部のフィールドのみを受け取ることができます。そのためには、クエリパラメータに fields 値を含め、返したいトップレベルキーのカンマ区切りリストを指定します。 例えば、IPの国と都市のみを取得するリクエストは次のようになります。ユースケース
ウェブサイト訪問者のジオロケーション
IPアドレスからジオロケーションをリクエストするには、以下のテンプレートに固有のAPIキーを含めるだけです。 リクエストを行うために訪問者のIPを知る必要はありません。レスポンスおよびエラーコード
何らかの理由でリクエストが失敗した場合、エラーもJSON形式で返されます。エラーにはエラーコードと説明が含まれ、詳細は以下のとおりです。国コード
以下はレスポンスで使用される2文字のISO 3166 Alpha 2国コードのリストです。このリストを CSV で表示できます。その他の注意事項
課金に関する重要な情報:処理するIPアドレスごとに1クレジットを消費します。レスポンスが成功したかどうかに関わらず、リクエスト送信ごとに課金されます。そのため、「fda3346ds」のような無効なIPアドレスを送信しても、1クレジットがアカウントから差し引かれます。IPジオロケーションAPI