Available in Classic and VPC
Maps is a NAVER Cloud Platform software interface that enables you to create location-based services utilizing NAVER Maps content and data. It provides APIs for static map image generation, route navigation, address search, and address conversion features in RESTful form, and IAM authentication with API Gateway must be completed to call the APIs.
Common Maps settings
The following describes commonly used request and response formats in Maps APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
Static Map: https://naveropenapi.apigw.ntruss.com/map-static/v2
Directions 5: https://naveropenapi.apigw.ntruss.com/map-direction/v1
Directions 15: https://naveropenapi.apigw.ntruss.com/map-direction-15/v1
Geocoding: https://naveropenapi.apigw.ntruss.com/map-geocode/v2
Reverse Geocoding: https://naveropenapi.apigw.ntruss.com/map-reversegeocode/v2
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-api-key-id |
Required | Client ID issued after application registration in NAVER Cloud Platform console |
x-ncp-apigw-api-key |
Required | Client secret issued after application registration in NAVER Cloud Platform console |
For information on how to register an application in the NAVER Cloud Platform console to obtain authentication information (client ID, client secret) required to use the API, see Maps User Guide.
In the console, make sure that the API you want to use after registering the application is selected by clicking the [Edit] button. If it is not selected, you will receive a 429 (Quota Exceed) error.
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 400 | 100 | Bad Request Exception | Request syntax error |
| 401 | 200 | Authentication Failed | Authentication failed |
| 401 | 210 | Permission Denied | Access unauthorized |
| 404 | 300 | Not Found Exception | Not found on server |
| 413 | 430 | Request Entity Too Large | Request size (10 MB) exceeded |
| 429 | 400 | Quota Exceeded | Request quota exceeded |
| 429 | 410 | Throttle Limited | Too fast or frequent requests |
| 429 | 420 | Rate Limited | Too many requests in a given time period |
| 503 | 500 | Endpoint Error | Endpoint error |
| 504 | 510 | Endpoint Timeout | Endpoint timeout |
| 500 | 900 | Unexpected Error | Unknown error |
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Maps API
The following describes the APIs provided by the Maps service.
| API | Description |
|---|---|
| Static Map | Create static map image |
| Directions 5 | Navigate routes (up to 5 waypoints) |
| Directions 15 | Navigate routes (up to 15 waypoints) |
| Geocoding | Search address |
| Reverse Geocoding | Convert coordinates to address |
Maps related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Maps APIs.
- Maps API guides
- API overview: how to issue and check access key and secret key issued by NAVER Cloud Platform, how to generate the signature required for request headers
- API Gateway User Guide: how to check the API key required for the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Maps service
- How to use the Maps service
- Maps User Guide: how to use Maps in the NAVER Cloud Platform console
- Ncloud use environment guide: guide on VPC and Classic environments and supported features
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of Maps
- Latest service news: the latest news on Maps
- FAQ: frequently asked questions from Maps users
- Contact us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.