geoLocation
- 印刷する
- PDF
geoLocation
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
IPアドレスを指定して、地理的位置情報を検索します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /geoLocation |
リクエストヘッダ
GeoLocation APIで共通して使用されるヘッダの詳細は、GeoLocationのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
ip | String | Required | 地域情報を知りたいユーザー IPアドレス
|
ext | String | Optional | 追加情報を含むかどうか
|
enc | String | Optional | レスポンス結果のエンコード方式
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://geolocation.apigw.ntruss.com/geolocation/v2/geoLocation
?ip=**.**.**.**
&ext=t
&enc=utf8
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
requestId | String | Required | APIリクエスト ID |
returnCode | String | Required | 正常なコードは0、それ以外はエラーコード |
country | String | Required | IPアドレスに当てはまる国コード
|
code | String | Required | 韓国行政安全部で定義した行政区域コード |
r1 | String | Required | 都、広域市、州 |
r2 | String | Required | 市、郡、区 |
r3 | String | Optional | 洞、面、邑 |
lat | Number | Optional | 緯度 |
long | Number | Optional | 経度 |
net | String | Optional | 通信キャリア名 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
HTTPステータスコード | コード | メッセージ | 説明 |
---|---|---|---|
400 | 131000 | No Entry | リクエストした IPアドレスの地域情報が見つからない
|
400 | 131001 | Invalid IP | グローバル IPアドレスではないか、無効な IPアドレス形式
|
400 | 131002 | Internal Server Error | GeoLocationサーバエラー
|
400 | 131003 | Quota Limit Reached | ユーザーが設定した API呼び出し限度超過
|
400 | 131004 | Subscription Required | GeoLocationサービスの申し込みが必要
|
レスポンス例
レスポンスのサンプルコードは次の通りです。
- 韓国内、
ext=f
、responseFormatType=xml
の場合
<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
<returnCode>0</returnCode>
<requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
<geoLocation>
<country>KR</country>
<code>41135*****</code>
<r1>京畿道</r1>
<r2>城南市盆唐区</r2>
</geoLocation>
</getLocationResponse>
- 韓国内、
ext=f
、responseFormatType=json
の場合
{
"returnCode": 0,
"requestId": "c4e52003-****-****-****-66c93acfd0d2",
"geoLocation": {
"country": "KR",
"code": "41135*****",
"r1": "京畿道",
"r2": "城南市盆唐区",
}
}
- 海外、
ext=f
、responseFormatType=xml
の場合
<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
<returnCode>0</returnCode>
<requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
<geoLocation>
<country>US</country>
<code></code>
<r1>California</r1>
<r2>San Francisco</r2>
</geoLocation>
</getLocationResponse>
- 海外、
ext=f
、responseFormatType=json
の場合
{
"returnCode": 0,
"requestId": "c4e52003-****-****-****-66c93acfd0d2",
"geoLocation": {
"country": "US",
"code": "",
"r1": "California",
"r2": "San Francisco",
}
}
- 韓国内、
ext=t
、responseFormatType=xml
の場合
<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
<returnCode>0</returnCode>
<requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
<geoLocation>
<country>KR</country>
<code>41135*****</code>
<r1>京畿道</r1>
<r2>城南市盆唐区</r2>
<r3>亭子洞</r3>
<lat>**.268***</lat>
<long>**.030***</long>
<net>Korea Telecom</net>
</geoLocation>
</getLocationResponse>
- 韓国内、
ext=t
、responseFormatType=json
の場合
{
"returnCode": 0,
"requestId": "c4e52003-****-****-****-66c93acfd0d2",
"geoLocation": {
"country": "KR",
"code": "41135*****",
"r1": "京畿道",
"r2": "城南市盆唐区",
"r3": "亭子洞",
"lat": **.268***,
"long": **.030***,
"net": "Korea Telecom"
}
}
- 海外、
ext=t
、responseFormatType=xml
の場合
<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
<returnCode>0</returnCode>
<requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
<geoLocation>
<country>US</country>
<code></code>
<r1>California</r1>
<r2>San Francisco</r2>
<r3></r3>
<lat>**.769***</lat>
<long>-***.393***</long>
<net>Fastly</net>
</geoLocation>
</getLocationResponse>
- 海外、
ext=t
、responseFormatType=xml
の場合
{
"returnCode": 0,
"requestId": "c4e52003-****-****-****-66c93acfd0d2",
"geoLocation": {
"country": "US",
"code": "",
"r1": "California",
"r2": "San Francisco",
"r3": "",
"lat": **.769***,
"long": -***.393***,
"net": "Fastly"
}
}
例
GeoLocationのサンプルファイルをダウンロードして、GeoLocation APIをテストしたり、例として活用することができます。
この記事は役に立ちましたか?