시작하기
네이버 지도 SDK를 사용하기 위해서는 네이버 클라우드 플랫폼에서 클라이언트 ID를 발급받고, 발급받은 ID를 SDK에 지정해야 합니다.
지원 OS 버전
네이버 지도 SDK는 iOS 버전 9 이상에서 사용할 수 있습니다.
클라이언트 ID 발급
네이버 지도 모바일 SDK를 사용하려면 다음과 같이 애플리케이션을 등록하고 클라이언트 ID를 발급받아야 합니다.
- 네이버 클라우드 플랫폼에 로그인한 후 콘솔에 들어갑니다.
- Products & Services에서 AI-Application Service 하위의 AI·NAVER API를 선택합니다.
- Application 등록을 선택하고 Maps 하위의 Mobile Dynamic Map을 체크합니다.
- 선택하지 않으면 인증 실패 오류(429)가 발생합니다.
- iOS Bundle ID에 네이버 지도 SDK를 사용하고자 하는 앱의 번들 ID를 추가하고 등록합니다.
- 올바르게 입력하지 않으면 인증 실패 오류(401)가 발생합니다.
- 등록한 애플리케이션의 인증 정보를 선택해 Client ID를 확인합니다.
자세한 방법은 Application 사용 가이드를 참조하세요.
의존성 추가
네이버 지도 SDK는 cocoapods를 통해 배포됩니다.
또한 대용량 파일을 받기 위해 git-lfs 설치가 필요합니다.
앱 프로젝트의 Podfile
에 네이버 지도 SDK에 대한 의존성을 선언합니다.
다음은 네이버 지도 SDK에 대한 의존성을 선언한 예제입니다.
target 'NaverMapDemo' do
pod 'NMapsMap'
end
클라이언트 ID 지정
발급받은 클라이언트 ID를 SDK에 지정하면 지도 API를 사용할 수 있습니다. 클라이언트 ID는 두 가지 방식으로 지정할 수 있습니다.
info.plist에 지정
info.plist
의 Custom Keys
로 클라이언트 ID를 지정할 수 있습니다. info.plist
에 새로운 요소를 추가하고, key
로 NMFClientId
를, string
으로 API 키를 지정합니다.
다음은 info.plist
에 클라이언트 ID를 지정하는 예제입니다.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
<key>NMFClientId</key>
<string>YOUR_CLIENT_ID_HERE</string>
...
<dict>
<plist>
공공기관용 클라이언트는 NMFClientId
대신 NMFGovClientId
를 지정해야 합니다.
다음은 info.plist
에 공공기관용 클라이언트를 지정하는 예제입니다.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
<key>NMFGovClientId</key>
<string>YOUR_CLIENT_ID_HERE</string>
...
<dict>
<plist>
API를 호출해 지정
info.plist
를 수정하지 않고 API를 호출해 클라이언트 ID를 지정할 수도 있습니다. AppDelegate
의 -application:didFinishLaunchingWithOptions:
내에서 NMFAuthManager.clientId
에 직접 설정할 수 있습니다. NMFAuthManager
는 싱글턴 클래스이므로 +shared
를 호출해 인스턴스를 얻어와야 합니다.
다음은 API를 호출해 클라이언트 ID를 지정하는 예제입니다.
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
NMFAuthManager.shared().clientId = "YOUR_CLIENT_ID_HERE"
return true
}
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
NMFAuthManager.shared().clientId = "YOUR_CLIENT_ID_HERE"
return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[NMFAuthManager shared].clientId = @"YOUR_CLIENT_ID_HERE";
return YES;
}
공공기관용 클라이언트는 clientId
대신 govClientId
를 사용합니다.
다음은 API를 호출해 공공기관용 클라이언트를 지정하는 예제입니다.
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
NMFAuthManager.shared().govClientId = "YOUR_CLIENT_ID_HERE"
return true
}
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
NMFAuthManager.shared().govClientId = "YOUR_CLIENT_ID_HERE"
return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[NMFAuthManager shared].govClientId = @"YOUR_CLIENT_ID_HERE";
return YES;
}
지도 표시
클라이언트 ID를 지정하고 NMFMapView
를 뷰 컨트롤러에 추가하면 지도가 화면에 나타납니다.
다음은 코드에서 직접 NMFMapView
를 추가해 지도를 화면에 나타내는 예제입니다.
override func viewDidLoad() {
super.viewDidLoad()
let mapView = NMFMapView(frame: view.frame)
view.addSubview(mapView)
}
Swift
override func viewDidLoad() {
super.viewDidLoad()
let mapView = NMFMapView(frame: view.frame)
view.addSubview(mapView)
}
Objective-C
- (void)viewDidLoad {
[super viewDidLoad];
NMFMapView *mapView = [[NMFMapView alloc] initWithFrame:self.view.frame];
[self.view addSubview:mapView];
}
XIB
나 storyboard
등의 Interface Builder를 사용한다면, UIView
를 추가하고 Custom Class
로 NMFMapView
를 지정합니다.
인증 실패 처리
클라이언트 ID를 잘못 지정했거나 사용량이 쿼터를 초과한 경우 지도가 화면에 나타나지 않으며, console창과 UIAlertController
로 인증 오류 메시지가 출력됩니다. NMFAuthManager.delegate
속성을 지정해 -authorized:error:
델리게이트 메서드를 구현하면 인증 실패 이벤트를 받을 수 있습니다. 델리게이트 메서드를 구현하면 인증 처리시마다 델리게이트 메서드가 호출되며, 인증 성공 여부와 오류 코드가 파라미터로 전달됩니다. 또한 인증에 실패하더라도 UIAlertController
가 노출되지 않습니다. 각 파라메터의 의미는 다음과 같습니다.
autohrized
: 인증 성공 여부입니다. 인증에 성공하면NMFAuthStateAuthorized
가, 실패하면NMFAuthStateUnauthorized
가 전달됩니다.error
: 인증 실패의 원인입니다. 인증에 성공하면nil
입니다.code
속성으로 에러 코드를 확인할 수 있습니다. 주로 발생하는 에러 코드는 다음과 같습니다.
code |
설명 |
---|---|
401 | - 잘못된 클라이언트 ID를 지정함 - 잘못된 클라이언트 유형을 사용함 - 콘솔에서 앱 Bundle Identifier를 잘못 등록함 |
429 | - 콘솔에서 Maps 서비스를 선택하지 않음 - 사용 한도가 초과됨 |
800 | 클라이언트 ID를 지정하지 않음 |