- 印刷する
- PDF
Static Map API
- 印刷する
- PDF
VPC環境で利用できます。
JavaScriptを使用したり、動的ページをロードせず、入力した座標を基準に指定したサイズの NAVER地図画像(Static Map)を読み込みます。サポートするパラメータ(地図のタイプ、画像形式、解像度、マーカーなど)を使用すると必要に応じて地図画像を設定できます。
リクエスト
リクエスト形式を説明します。
メソッド | URI | 説明 |
---|---|---|
GET | /raster | ID-KEY認証 |
GET | /raster-cors | HTTP Referer認証 |
- HTTP Refere認証方式を使用して APIを呼び出すには、Application登録時に Webサービス URLを入力する必要があります。次のガイドをご参照ください。
- HTTP Referer認証方法を使用する場合、次のように HTMLタグを追加してリクエストすることができます。
<img src="https://naveropenapi.apigw.ntruss.com/map-static/v2/raster-cors?w=300&h=300¢er=127.1054221,37.3591614&level=16&X-NCP-APIGW-API-KEY-ID={API Gateway API Key ID}">
リクエストヘッダ
Maps APIで共通して使用されるヘッダの詳細は、Mapsの共通ヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
crs | String | Optional | 座標システム
|
center | String | Conditional | 中心座標(X座標,Y座標)
|
level | Integer | Conditional | ズームレベル
|
w , h | Integer | Required | 画像の横長、縦長サイズ
|
maptype | String | Optional | 地図のタイプ
|
format | String | Optional | 地図の画像形式
|
scale | Integer | Optional | 解像度
|
markers | String | Conditional | マーカー設定
|
lang | String | Optional | ラベル言語
|
dataversion | String | Optional | バージョン情報
|
markers
markers
の説明は次の通りです。
フィールド | 値 | 必須の有無 | 説明 |
---|---|---|---|
type | String | Optional | マーカータイプ
|
size | String | Optional | マーカーのサイズ
|
color | String | Optional | マーカーの色
|
label | String | Optional | マーカーのラベル
|
pos | String | Required | マーカーの位置(X座標,Y座標)
|
viewSizeRatio | Float | Optional | マーカーサイズの比率
|
icon | String | Conditional | カスタムマーカーアイコン URL
|
anchor | String, Double | Optional | マーカー表示位置
|
カスタムマーカー設定時の制限事項
- カスタムマーカーの最大サイズは基本64x64ピクセルで、Retinaディスプレイ対応高解像度(
scale=2
)でリクエストする場合は128x128ピクセルです。 - カスタムマーカーリクエスト URLから2秒以内にレスポンスがない場合は作業を停止します。
- カスタムマーカーは、最大1日間内部キャッシュで維持することができます。そのため、同じ URLにマーカーの画像だけが変わった場合は、最大1日まで変更された画像が反映されない場合があります。
Data Version API
Data Version APIの説明は次の通りです。
- リクエスト
メソッド URL GET https://naveropenapi.apigw.ntruss.com/map-static/v2/lastversion - レスポンス
フィールド タイプ 必須の有無 説明 version
String - バージョン情報 major_version.minor_version
形式major_version
: 定期更新時に変更、ワンタイルマップメジャーバージョンと同様に維持(2か月に1回更新)minor_version
: 一部更新時にバージョンアップ(1か月に1~2回更新)
interval
Long - 推奨更新周期(秒)
リクエスト例
リクエストのサンプルコードは次の通りです。
このガイドでは、ID-KEY認証方式を使用するサンプルコードを提供します。
center
中心座標(center
)が127.1054221,37.3591614
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
level
中心レベル(level
)が11
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
w
, h
サイズ(w
x h
)が300 x 200ピクセルの地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=200¢er=127.1054221,37.3591614&level=16' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
maptype=basic
地図タイプ(maptype
)が一般地図(basic
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11&maptype=basic' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
maptype=traffic
地図タイプ(maptype
)が交通情報地図(traffic
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11&maptype=traffic' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
maptype=satellite
地図タイプ(maptype
)が衛星地図(satellite
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11&maptype=satellite' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
maptype=satellite_base
地図タイプ(maptype
)が衛星背景地図(satellite_base
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11&maptype=satellite_base' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
maptype=terrain
地図タイプ(maptype
)が地形図(terrain
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=11&maptype=terrain' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
format=jpg
画像形式(format
)がjpg
(jpeg
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16&format=jpg' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
format=png8
画像形式(format
)がpng8
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16&format=png8' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
format=png
画像形式(format
)がpng
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16&format=png' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
scale=1
低解像度(scale=1
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16&scale=1' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
scale=2
高解像度(scale=2
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300¢er=127.1054221,37.3591614&level=16&scale=2' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
lang=ko
ラベル言語(lang
)が韓国語(ko
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?crs=EPSG:4326&w=375&h=258¢er=126.96311062857343,37.50843783043817&level=16&lang=ko' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
lang=en
ラベル言語(lang
)が英語(en
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?crs=EPSG:4326&w=375&h=258¢er=126.96311062857343,37.50843783043817&level=16&lang=en' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
lang=ja
ラベル言語(lang
)が日本語(ja
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?crs=EPSG:4326&w=375&h=258¢er=126.96311062857343,37.50843783043817&level=16&lang=ja' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
lang=zh
ラベル言語(lang
)が中国語(簡体字)(zh
)の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?crs=EPSG:4326&w=375&h=258¢er=126.96311062857343,37.50843783043817&level=16&lang=zh' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=size:tiny
基本マーカーのサイズ(size
)がtiny
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:tiny|pos:127.1054221%2037.3591614' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=size:small
基本マーカーのサイズ(size
)がsmall
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:small|pos:127.1054221%2037.3591614' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=size:mid
基本マーカーのサイズ(size
)がmid
の地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:mid|pos:127.1054221%2037.3591614' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=size:mid&markers=size:small&markers=size:tiny
サイズ(size
)がmid
、small
、tiny
の基本マーカーをすべて表示する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:mid|pos:126.9865479%2037.5612557&markers=type:d|size:small|color:red|pos:126.9870479%2037.5695075%2C126.9950680%2037.5612557%2C126.9743160%2037.5620754&markers=type:d|size:tiny|color:green|pos:126.9810479%2037.5695075%2C126.9950680%2037.5672557%2C126.9843160%2037.5570754' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=color:red
基本マーカーの色(color
)が赤(red
)の地図画像をリクエストするサンプルコードは次の通りです。
- 事前定義色でリクエスト
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:small|pos:127.1054221%2037.3591614|color:red' \ --header 'x-ncp-apigw-api-key-id: {API Key ID}' \ --header 'x-ncp-apigw-api-key: {API Key}'
- 24ビット色でリクエスト
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:small|pos:127.1054221%2037.3591614|color:0xFF6355' \ --header 'x-ncp-apigw-api-key-id: {API Key ID}' \ --header 'x-ncp-apigw-api-key: {API Key}'
markers=viewSizeRatio:0.5
基本マーカーサイズの比率(viewSizeRatio
)を0.5倍(0.5
)に変更する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:mid|pos:127.1054221%2037.3591614|viewSizeRatio:0.5' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=viewSizeRatio:2.0
基本マーカーサイズの比率(viewSizeRatio
)を2倍(2.0
)に変更する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:d|size:mid|pos:127.1054221%2037.3591614|viewSizeRatio:2.0' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=type:n|label:{number}
数字マーカーを表示する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:n|size:mid|pos:126.9865479%2037.5612557|label:1&markers=type:n|size:small|color:blue|pos:126.9870479%2037.5695075|label:2&markers=type:n|size:small|color:blue|pos:126.9950680%2037.5612557|label:3&markers=type:n|size:small|color:blue|pos:126.9743160%2037.5620754|label:4' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=type:a|label:{alphabet}
英字マーカーを表示する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&markers=type:a|size:mid|pos:126.9865479%2037.5612557|label:a&markers=type:a|size:small|color:blue|pos:126.9870479%2037.5695075|label:b&markers=type:a|size:small|color:blue|pos:126.9950680%2037.5612557|label:c&markers=type:a|size:small|color:blue|pos:126.9743160%2037.5620754|label:d' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=type:t|label:{tooltip}
ツールチップマーカーを表示する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?crs=EPSG:4326&scale=1&format=png&w=375&h=258&markers=type:t|pos:126.9616187%2037.507435|label:%EB%8F%99%EC%9E%91%EA%B5%AC,%20%EC%84%9C%EC%B4%88%EA%B5%AC,%20%EA%B4%80%EC%95%85%EA%B5%AC&markers=type:t|color:blue|pos:126.96060539999999%2037.507685699999996|label:%EB%8F%99%EC%9E%91%EA%B5%AC,%20%EC%84%9C%EC%B4%88%EA%B5%AC,%20%EC%9A%A9%EC%82%B0%EA%B5%AC%20%EB%B0%A9%EB%A9%B4&markers=type:t|color:0xEE3A3A|pos:126.9616377%2037.506708950000004|label:%EB%8F%99%EC%9E%91%EA%B5%AC,%20%EC%84%9C%EC%B4%88%EA%B5%AC,%20%EC%9A%A9%EC%82%B0%EA%B5%AC%20%EB%B0%A9%EB%A9%B4' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
markers=type:e
カスタムマーカーを表示する地図画像をリクエストするサンプルコードは次の通りです。
curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-static/v2/raster?w=300&h=300&scale=2&markers=type:e|anchor:center|icon:https://aaa.bbb.com/icon/construction-medium@2x.png|pos:127.0597827%2037.5118871' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
HTTPステータスコード | コード | メッセージ | 説明 |
---|---|---|---|
400 | 100 | Bad request | リクエストに無効なパラメータが入力される |
500 | 900 | Internal error | Mapsサーバエラー
|
503 | 500 | Service Unavailable | システムのメンテナンスにより一時的にレスポンスができない状態
|
504 | 510 | Gateway Timeout | システム過負荷により一時的にレスポンスができない状態
|
Maps APIで共通して使用されるレスポンスステータスコードの詳細は、Mapsの共通レスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
center
中心座標(center
)が127.1054221,37.3591614
の地図画像のレスポンスのサンプルコードは次の通りです。
level
ズームレベル(level
)が11
の地図画像のレスポンスのサンプルコードは次の通りです。
w
, h
サイズ(w
x h
)が300 x 200ピクセルの地図画像のレスポンスのサンプルコードは次の通りです。
maptype=basic
地図タイプ(maptype
)が一般地図(basic
)の地図画像のレスポンスのサンプルコードは次の通りです。
maptype=traffic
地図タイプ(maptype
)が交通情報地図(traffic
)の地図画像のレスポンスのサンプルコードは次の通りです。
maptype=satellite
地図タイプ(maptype
)が衛星地図(satellite
)の地図画像のレスポンスのサンプルコードは次の通りです。
maptype=satellite_base
地図タイプ(maptype
)が衛星背景地図(satellite_base
)の地図画像のレスポンスのサンプルコードは次の通りです。
maptype=terrain
地図タイプ(maptype
)が地形図(terrain
)の地図画像のレスポンスのサンプルコードは次の通りです。
format=jpg
画像形式(format
)がjpg
(jpeg
)の地図画像のレスポンスのサンプルコードは次の通りです。
format=png8
画像形式(format
)がpng8
の地図画像のレスポンスのサンプルコードは次の通りです。
format=png
画像形式(format
)がpng
の地図画像のレスポンスのサンプルコードは次の通りです。
scale=1
低解像度(scale=1
)の地図画像のレスポンスのサンプルコードは次の通りです。
scale=2
高解像度(scale=2
)の地図画像のレスポンスのサンプルコードは次の通りです。
lang=ko
ラベル言語(lang
)が韓国語(ko
)の地図画像のレスポンスのサンプルコードは次の通りです。
lang=en
ラベル言語(lang
)が英語(en
)の地図画像のレスポンスのサンプルコードは次の通りです。
lang=ja
ラベル言語(lang
)が日本語(ja
)の地図画像のレスポンスのサンプルコードは次の通りです。
lang=zh
ラベル言語(lang
)が中国語(簡体字)(zh
)の地図画像のレスポンスのサンプルコードは次の通りです。
markers=size:tiny
基本マーカーのサイズ(size
)がtiny
の地図画像のレスポンスのサンプルコードは次の通りです。
markers=size:small
基本マーカーのサイズ(size
)がsmall
の地図画像のレスポンスのサンプルコードは次の通りです。
markers=size:mid
基本マーカーのサイズ(size
)がmid
の地図画像のレスポンスのサンプルコードは次の通りです。
markers=size:mid&markers=size:small&markers=size:tiny
サイズ(size
)がmid
、small
、tiny
の基本マーカーをすべて表示する地図画像のレスポンスのサンプルコードは次の通りです。
markers=color:red
基本マーカーの色(color
)が赤(red
)の地図画像のレスポンスのサンプルコードは次の通りです。
markers=viewSizeRatio:0.5
基本マーカーサイズの比率(viewSizeRatio
)を0.5倍(0.5
)に変更する地図画像のレスポンスのサンプルコードは次の通りです。
markers=viewSizeRatio:2.0
基本マーカーサイズの比率(viewSizeRatio
)を2倍(2.0
)に変更する地図画像のレスポンスのサンプルコードは次の通りです。
markers=type:n|label:{number}
数字マーカーを表示する地図画像のレスポンスのサンプルコードは次の通りです。
markers=type:a|label:{alphabet}
英字マーカーを表示する地図画像のレスポンスのサンプルコードは次の通りです。
markers=type:t|label:{tooltip}
ツールチップマーカーを表示する地図画像のレスポンスのサンプルコードは次の通りです。
markers=type:e
カスタムマーカーを表示する地図画像のレスポンスのサンプルコードは次の通りです。