[안드로이드] 맵뷰 - T MAP API 이용하여 개발하기 1

2013. 12. 30. 19:21Programing/Android / Java

1. 개요

SK플래닛 개발자센터 개발자센터에서는 다양한 API 활용하여 여러분 만의 새로운 앱 또는 서비스를 쉽게 개발할 수 있도록 체계적인 방법을 제공합니다.SK planet에서 제공하는 다양한 API를 학습하고, SDK를 통해 앱 개발에 적용하고 테스트하며, 커뮤니티에서 동료 개발자들과 정보를 공유하고, 여러분이 만든 앱을 스스로 관리할 수 있습니다.

앱을 개발하는 순서는 다음과 같습니다.

Step1. 개발자 등록하기

Step2. API 문서 읽기 및 사용할 API 정하기

Step3. API Console에서 API 개발 연습하기

Step4. 앱 등록 및 API키 발급 받기

Step5. 사용자 인증을 위해 OAuth Access Token 획득 연습하기

Step6. 앱 개발하기

Step7. 개발자 포럼을 통해 SK플래닛 개발자센터 Engineer 및 타 개발자들과 소통하며 경험 공유하기


2. 시작하기

SK플래닛 개발자센터가 제공하는 API을 사용하기 위해서는 먼저 개발자 센터에 회원 가입을 해야 합니다. 회원가입이 끝나면, 개발을 위해 앱을 등록을 하고 API 인증키를 할당 받습니다. 등록할 앱 정보는 아이디어 만으로도 충분합니다.할당 받은 API 인증키는 SK플래닛 개발자센터가 앱을 식별하거나 사용자 인증에 필요한 Access Token을 획득하는데 사용됩니다.

록하기 전에

+ 서비스 이용 정책

많은 사람들이 Open API를 편리하게 사용할 수 있도록, SK플래닛 개발자센터를 위한 서비스 이용 가이드가 제공되고 있습니다.

서비스를 이용하기 전, 반드시 사용량 가이드Open API 이용약관을 읽으십시오.개발자는 기본적으로 SK플래닛 개발자센터가 제공하는 모든 API를 사용할 수 있습니다. 다만 많은 개발자들이 사용할 수 있도록, 일일 최대 사용량에 제한을 가할 수 있습니다. 

또한 안정적인 서비스 제공을 위해서, 서비스 API별로 사용량 제한을 둘 수 있습니다.

다른 개발자의 이용과 안정적인 서비스 운영에 영향을 줄 수 있는 사안인 경우, API 사용이 제한될 수 있음을 명심하십시오.

자세한 내용은 사용량 가이드Open API 이용약관을 참조하십시오.

+ 제공 API 소개

SK플래닛 개발자센터에서는 SK planet과 제휴사가 보유한 다양한 자원과 기능을 활용하여 서비스를 개발할 수 있도록, 다수의 API를 제공하고 있습니다. 이를 통해 개발자는 소셜 서비스, 지도 서비스, 클라우드 서비스, 엔터테인먼트 등의 서비스나 Mash-up을 구축할 수 있습니다. 또한 개발자가 앱을 쉽게 개발할 수 있도록, 다수의 앱에서 필요로 하는 공통 모듈 및 기능을 Component API 형태로 제공하고 있습니다.

다음은 SK플래닛 개발자센터가 제공하는 API 서비스의 분류입니다.

자세한 내용은 API 소개를 이용해주세요.

+ API 관련 기술 정보

SK플래닛 개발자센터는 개발자가 좀 더 쉽게 앱을 개발할 수 있도록 REST 방식의 Open API와 다양한 SDK를 제공합니다.

보다 원활한 앱 개발을 위해 다음 정보와 기술을 참조하시기 바랍니다.

1) XML(관련 정보는 W3 School의 XML Tutorial 참조).

2) JSON(관련 정보는 json 재단 참조).

3) 기본적인 Web 서비스에 대한 이해(관련 정보는 W3 School의 Web Services Tutorial 참조)

4) REST Protocol에 대한 이해

5) 개발자센터는 REST API 외에 Mobile 서비스 개발을 위한 Android OS용 SDK와 iOS용 SDK를 제공하고 있습니다.
    Open API 전반에 관한 상세 내용은 여기를 클릭하십시오.
    SDK 전반에 대한 내용은 여기를 클릭하십시오.

Step1. 개발자 등록하기
먼저, 개발자센터에서 회원 가입을 하십시오.
SK플래닛 개발자센터가 제공하는 Open API를 이용해서 앱을 개발하려면, 개발자센터 회원이 되어야 합니다.
SK플래닛 개발자센터는 SK planet이 제공하는 One ID 기반의 회원 가입을 지원합니다.
One ID를 이용하면 하나의 ID를 통해 멜론, 호핀, 11번가 등에서 제공하는 다양한 서비스를 이용할 수 있습니다.
아직 One ID가 없으십니까? 지금 개발자센터 회원이 되시고 One ID를 받으시기 바랍니다.
그럼 지금부터 회원가입 과정을 단계별로 알아보겠습니다.

1) 홈페이지 상단 Log in 메뉴를 선택하면 아래와 같은 화면을 볼 수 있습니다.
    회원가입 버튼을 클릭하고 회원가입 절차를 진행합니다. SK플래닛 개발자센터의 회원은 SK플래닛 OneID를 사용합니다.
회원가입 화면

2) SK플래닛 OneID에 대한 자세한 설명은 아래 ①링크로 이동해서 볼 수 있습니다.
만약 다른 사이트에서 SK플래닛 OneID를 가입한 이력이 있다면 동일한 아이디로 SK플래닛 개발자센터를 이용 할 수 있습니다.
OneID가 기억나지 않으시면 로그인 버튼 옆에 있는 ②SK플래닛 One ID 찾기를 클릭해서 확인 하세요.
처음 가입하는 사용자는 ③링크 SK 플래닛 One ID 가입하기 버튼을 눌러서 회원가입을 진행하면 됩니다.
SK 플래닛 One ID 약관 동의와 SK플래닛 개발자센터 약관동의의 각 정책들을 읽어보고
동의 의사를 표시(아래 그림 참고) 한 후 확인 버튼을 누르시면 회원 정보 입력 화면으로 넘어갑니다.
회원가입 화면
회원가입 화면


3) 회원 정보 입력 화면은 아래 그림과 같습니다. 일반적인 웹사이트의 회원 가입 절차와 다르지 않습니다.
    * 표시되어 있는 필수 입력 항목 외 정보는 차후에 회원정보 관리 메뉴를 통해서 변경 할 수 있습니다.
   정상적으로 회원 정보를 입력하고 확인 버튼을 누르면 회원 가입을 위한 정보 입력 절차가 완료되고 인증 메일을 보냈다는 화면을 볼 수 있습니다.
회원가입 화면
회원가입 화면

4) 회원 정보 입력시 입력했던 이메일을 확인해 보면 회원가입 인증메일이 수신되어 있는 것을 확인 할 수 있습니다.
회원가입 화면

5) 가입완료 버튼을 누르면 아래 그림과 같이 SK플래닛 개발자센터 사이트의 인증 페이지로 링크되고 회원 가입이 완료 됩니다.
회원가입 화면

Note. 이제 회원 가입 절차가 모두 끝났습니다. 가입된 아이디와 비밀번호로 로그인 할 수 있습니다.


Step2. API 문서 읽기 및 사용할 API 정하기
API 문서를 클릭하면, 각 서비스 카테고리에서 제공하는 다양한 API 문서를 접할 수 있습니다.

API는 크게 사용자의 개인정보에 접근하는 Private API와 개인정보와 무관하게 사용할 수 있는 Public API로 분류할 수 있습니다.
그리고 각각의 API는 서비스 카테고리에 따라 제공되는 기능과 데이터가 달라집니다.
문서를 통해 이용할 API에 대한 내용과 기능을 이해하고 API 특성을 익혀두면, 앱 개발 시 도움이 됩니다.
모든 API는 기본적으로 개발자 동의를 거친 후, 이용할 수 있습니다.
단, 서비스 제공사의 정책에 따라, 일부 API는 사전 제휴 등의 절차가 필요할 수 있습니다.
상세한 내용은 해당 API 문서 및 각 서비스의 Open API 이용약관 등을 참조하시기 바랍니다.


Step3. API Console에서 API 개발 연습하기
API Console에서 다양한 API 사용을 체험할 수 있습니다. 사용 할 API를 실행시켜 보면서 활용 방법을 확인할 수 있는 도구를 제공합니다. API Console은 Open API에 대한 작동 및 기능을 직접 조작해 보면서 실제 결과값을 볼 수 있게 해줍니다.
Public API뿐만 아니라 사용자 정보를 활용하는 Private API 테스트도 지원합니다.
단, Private API를 테스트할 때 개발자 ID를 서비스 사용자 ID로 간주하여 사용자 인증을 진행하므로,
개발자 본인 ID가 해당 서비스에 가입되어 있는 상태여야만 합니다.
API Console 화면


Step4. 앱 등록 및 API 키 발급 받기
개발자센터 회원은 OpenAPI를 사용하기 위해서는 앱 개발에 앞서, 앱 등록 및 API 인증키 발급을 진행해야 합니다.
개발자센터 앱은 모바일 기기에서 구동되는 앱에 국한되는 의미가 아니라 좀 더 포괄적인 Applications를 가리킵니다.
등록할 앱 정보는 아이디어만으로도 충분합니다. 앱을 등록하고 나면, 사용 API에 대한 키를 발급 받게 됩니다.
우선, 회원 로그인후 앱등록을 위해 마이앱 메뉴로 이동합니다.

Note. 앱등록 및 API키 발급은 Home > 개발 > 앱 등록 및 키 발급 메뉴에서도 가능합니다.

다음 페이지에서 아래와 같은 화면을 볼 수 있습니다.
현재 등록된 앱이 없는 상태이므로 앱 관리 화면에서는 조회된 앱이 없습니다.
우측 상단 '앱등록' 메뉴를 선택해서 앱 등록 과정을 진행해 보겠습니다.

앱 등록 및 API 키 발급 받기 화면

앱 등록 화면은 아래와 같습니다.

화면 상단에 약관 동의, 앱 등록, 인증 키 발급, 서비스 선택의 진행상황을 표시하는 탭이 있습니다.
현재는 약관 동의 단계를 표시하고 있습니다.
이용약관을 읽어보시고 우측 하단 ‘오픈 API 이용 기본 약관에 동의 합니다.’ 앞의 체크 박스를 선택 후
하단의 확인 버튼을 누르면 다음 단계로 이동합니다.
앱 등록 및 API 키 발급 받기 화면

Open API를 사용하실 여러분은 결과물이 웹 사이트 일 경우가 대부분입니다.
사용자 단에서의 접속 경로가 모바일 기기라 할 지라도 서비스 단이 ‘웹 사이트’ 이기 때문에 서비스 타입을 Web으로 정하시면 됩니다.

서비스 타입을 선택했다면 서비스될 URL을 입력합니다. URL 입력칸은 Service URL과 Redirect URL로 나뉘어져 있습니다.
일반적으로 같은 URL을 입력하면 문제 없이 진행됩니다.
중복확인 버튼은 입력된 URL이 SK플래닛 개발자센터에 이미 등록된 URL인지 검사합니다.

서비스 제공자 선택 항목에서 본인 또는 회사의 이름을 실명 인증 해야 합니다. 실명 인증 과정은 생략하겠습니다.
이미 여러분들이 포탈 사이트 가입 이나 인터넷 쇼핑 결제등을 통해서 인증한 방식과 같습니다.
트랙킹 로그의 사용 여부는 등록한 앱의 호출 회수 등의 로그 정보를 제공 받기 위한 항목입니다.

등록 앱 정보
- 앱 이름: 앱의 이름
- 앱 설명: 앱이 제공하는 서비스에 대한 설명
- 앱 아이콘: 앱의 대표 이미지
- 서비스 타입: Web인 경우는 Redirect URL 필요
- 서비스 제공자 선택: 개인 또는 기업 실명을 필요로 함
- 국적 선택 : 회원의 국적 선택
- 트래킹 로그 사용 선택: 앱 개발 시 로그 내용을 열람

앱 등록 및 API 키 발급 받기 화면

정보 입력이 끝나고 확인 버튼을 누르면 다음 단계로 넘어갑니다.

다음 화면에서 앱등록시 입력한 정보가 요약되어 표시됩니다.
하단, '인증 키 발급 받기' 버튼을 누르면 인증키가 발급 됩니다.

앱 등록 및 API 키 발급 받기 화면

API인증키는 앱을 식별하기 위한 키 값으로 APP Key, client_ID, Secret Key 로 구성되어 있습니다.


- Client ID : 사용자 인증(User Authentication) 시 앱을 식별하기 위한 고유키로 Private API를 사용하는 앱 개발에 필요합니다.
- Secret Key : client_ID와 함께 발급하는 키로 앱이 client_ID에 대한 소유권이 있는지를 검증하는 용도로 사용합니다.
                       Private API를 사용하는 앱 개발에 필요합니다. 
- APP Key : 앱을 식별하기 위한 고유키입니다.
                    앱 개발자의 필요에 따라 개발자센터 > 내 정보 > 앱 정보에서 재발급 받을 수 있습니다.

정상적으로 인증키가 발급되면 아래 화면과 같이 API사용을 위해서 원하는 서비스 항목을 체크합니다.
서비스 선택 화면

동일 화면에서, 선택한 서비스의 약관을 읽어보시고 '이용약관에 동의합니다' 앞의 체크박스를 선택 후
하단의 '서비스 선택 완료 버튼'을 누르면 앱 등록 및 키발급이 완료됩니다.서비스 선택 화면

서비스 선택 화면
이제 앱등록 및 API키가 정상적으로 발급되었습니다. 사용자 인증 후 앱개발을 진행하시면 됩니다.
Note. App Key에 대한 사용법은 뒤에 이어지는 SK플래닛 개발자센터의 API 표준을 참조하십시오.

Step5. 사용자 인증을 위해 OAuth Access Token 획득 연습하기
API를 안전하게 사용하기 위해서는 다음 사항을 반드시 유념해야 합니다.
앱의 사용자들에게 보다 편리하고 안전한 서비스 제공을 원한다면, 사용자 인증 서비스 적용을 권장합니다.
특히 Private API를 이용한 서비스 개발은 사용자 개인 정보를 다루어야 하므로 사용자 인증이 필수입니다.
따라서, 관련 내용을 충분히 숙지한 후 개발에 임해야 합니다.
SK플래닛 개발자센터는 보다 안전하고 편리한 서비스 제공을 위해, OAuth 2.0 기반의 사용자 인증 체계를 제공하고 있습니다.
OAuth에 대해 자세히 알아보려면, 아래 URL을 방문해서 위키백과 정보로 참고하실 수 있습니다.


Note.
사용자 인증에 대한 자세한 사항은 인증 이용 가이드를 참조하십시오.

3. Reference
SK플래닛 개발자센터의 API 표준
SK planet에서 제공하는 Open API는 다음과 같은 기본 표준 체계를 따르고 있습니다. 용이한 개발을 위해, API 규격에 대한 체계를 숙지하시기 바랍니다.

Open API의 URI는 다음 형식으로 구성됩니다.
?http(s)://apis.skplanetx.com/[Service Area]/[Resource Category]/{Resource Path}/../{Path Variable} ?{Query String}

+ Service Area
서비스 식별 명칭은 아래 표와 같습니다.


+ Resource Category

각 Service Area의 하위 분류 체계이며, 상세 정보는 API 메뉴를 참조하십시오.


+ Query String

서버에 전송해야 하는 값으로, 요청 URL 뒤에 변수명과 값을 ‘name=value’ 형식으로 명시합니다. 요청 변수가 많으면 ‘&’로 구분합니다.
요청 변수에는 필수 변수와 선택적 변수가 있습니다.


* 필수 변수
version: Open API의 버전을 의미하며 ‘version=1’과 같이 명시


* 선택적 변수
_method: ‘GET’, ‘POST’만 허용하는 브라우저에서 ‘PUT’, ‘DELETE’를 사용하기 위해서는, Http Method를 ‘POST’로 하고 ‘_method=DELETE’와 같이 명시하여 ‘DELETE’ 요청
count: 한 화면에 출력하고자 하는 Record 수
page: 요청하는 페이지 번호

HTTP Header를 컨트롤하기 어려운 환경일 경우, 제한적으로 ‘access_token=토큰값’과 ‘appKey=키값’, format=xml(또는json)을 Query String으로 사용할 수 있음

다음은 Open API를 호출할 때 전달하는 HTTP Common Request Header입니다.


4. More
뉴스 및 이벤트
마지막으로,
SK플래닛 개발자센터의 새로운 소식과 이벤트를 확인하십시오.
API 및 SDK 변경 사항, 운영과 관련한 새로운 소식, 개발자를 위한 다양한 이벤트 등을
뉴스 및 이벤트를 통해 접할 수 있습니다.
뉴스 및 이벤트 바로가기

포럼
SK플래닛 개발자센터는 개발자들의 다양한 의견 교환을 위해 포럼을 제공하고 있습니다.
포럼을 통해 다수의 개발자들과 더불어 다양한 문제 해결 방법과 창조적인 아이디어를 공유할 수 있습니다.
개발을 위한 기술 지원이 필요하다면 포럼을 통해 요청하십시오. SK플래닛 개발자센터는 API 버그 리포트를 포함한 모든 공식적인 개발자 지원 활동을 포럼을 통해 제공합니다.
포럼 바로가기


FAQ
SK플래닛 개발자센터와 개발자, 개발자들간에 자주 묻고 답하는 사항들을 FAQ에 등록해 두었습니다.
개발자센터 및 API 이용, 개발 관련 질문과 답변들이 제공됩니다.
보다 쉽고 빠르게 원하는 질문과 답변을 찾으려면, FAQ 검색 기능을 활용하십시오.
FAQ 바로가기

문의하기

포럼이나 FAQ에 등록된 내용 이외에 궁금한 사항 또는 개발자 센터에 대한 의견이나 개선 사항이 있으면,
문의하기를 통해 SK플래닛 개발자센터 운영자에게 문의하십시오.
문의하기에서의 문의와 답변은 이메일을 사용합니다.
문의하기 바로가기