서비스콘솔 (이하 콘솔)은 회원들이 Open API를 활용하여 개발을 진행할 수 있도록
지원하는 채널입니다.
콘솔을 통해 개발 프로젝트를 등록/공유, Client ID와 Clienct Secret 등의 정보를
확인, 데이터 응답 URL 설정, 테스트용 차량을 연동 등을 통해 차량 데이터를 확인할
수 있습니다.
이외의 상용화 신청, 기술지원 문의 등의 업무도 요청하실 수 있습니다.
API를 활용한 서비스를 구현하기 위해서는 프로젝트를 등록하여, API 사용권한 및
Client ID / Client Secret을 발급받아야 합니다.
신규 프로젝트 등록시에는 개발하고자 하는 서비스와 연동되어질 프로젝트를
생성해주시면 됩니다.
여러개의 서비스에 동일한 프로젝트를 사용할 수 없으니, 개발하고자 하는 서비스가
여러개라면 그에 맞게 프로젝트를 각각 등록해주셔야 합니다.
'신규 프로젝트 등록' 버튼을 통해 새로운 프로젝트
등록을 진행할 수 있으며, 새 프로젝트를 등록시에는 프로젝트명, API의 사용 목적과
내용을 입력해 주십시오.
만약, 디벨로퍼스 담당자와 사전 협의된 프로젝트를 등록하실 경우에는 원활한 업무
지원을 위해 업무담당자 항목에 담당자 정보를 꼭 입력해 주십시오.
신규 프로젝트는 기본적으로 '개발 프로젝트' 로
생성되며, 사용 가능한 모든 API 호출 권한을 자동으로 부여 받습니다.
프로젝트 생성이 완료되었다면, 생성된 프로젝트를 클릭하여 프로젝트 메인화면으로
이동합니다.
대고객 서비스를 위한 상용화신청이 승인된 이후에는 '상용화 프로젝트' 가 자동으로 생성되며, '상용화 프로젝트'의 설정정보, Client ID / Secret 을 확인해주셔야 합니다.
콘솔에서 생성한 프로젝트는 동료 개발자와 공유하여, 프로젝트 관련 설정이나 현황
등을 함께 볼 수 있습니다.
또한, 프로젝트의 Owner 이관이 가능하여 프로젝트의 멤버가 변경되거나 멤버 계정이
삭제되더라도 프로젝트를 계속 유지시킬 수 있습니다.
[프로젝트 개요] 메뉴에서
'신규 Member 초대' 버튼을 클릭하고, 공유를 원하는
회원의 메일을 입력해주세요.
디벨로퍼스 회원에게만 프로젝트 공유가 가능하므로, 프로젝트를 공유받을 회원은
디벨로퍼스에 가입이 되어 있는 상태여야 합니다.
프로젝트 코드는 랜덤으로 자동 생성됩니다. 공유 프로젝트 등록 시 입력할
비밀번호를 설정하고 초대하기 버튼을 클릭하면 프로젝트 코드와 비밀번호가 초대받은
멤버의 이메일로 전송됩니다.
초대된 멤버들은 콘솔 메인화면에서 '공유 프로젝트 등록' 버튼을 클릭하고, 공유 받은 프로젝트 코드와 비밀번호를 입력하면 프로젝트를 공유 받게 됩니다.
초대된 멤버들이 공유프로젝트 등록을 성공하면, 프로젝트 멤버 목록이 보여집니다.
계정이 삭제되거나 서비스 담당자가 변경되는 등 프로젝트의 Owner를 변경해야 할 경우, 기존 Owner는 프로젝트 멤버 중 새로운 Owner를 지정함으로써 프로젝트를 이관할 수 있습니다.
주의 : 프로젝트의 Owner가 통합계정을 탈퇴하게 되는 경우, Owner로 등록된 프로젝트 정보도 삭제되어 서비스 이용이 불가능하게 됩니다.
프로젝트의 Owner 분께서 통합계정 탈퇴시에는 Owner 이관 혹은 디벨로퍼스 공식계정으로 문의를 요청해주세요.
개발 프로젝트 삭제 권한은 Owner 만 보유합니다.
개발 프로젝트 내에 Member가
존재하더라도 프로젝트의 삭제가 가능하며, 삭제된 프로젝트에 대해서는 복구가
불가능하므로 유의하셔야 합니다.
상용화 중인 서비스의 개발/상용화 프로젝트의 삭제 기능은 제공되지 않습니다. 만약 상용 프로젝트의 삭제가 필요한 경우에는 디벨로퍼스 공식계정으로 (developers@kia.com) 요청해주십시오
프로젝트명은 제공하고자 하는 서비스명과 동일한 이름으로 작성하거나, 변경하여
기술해 주십시오.
Client ID 와 Client Secret 정보는 다음과 같은 API 호출 시 필수 값으로 지정이
되어야 하는 정보로, 보안에 각별히 유의하여 주십시오.
디벨로퍼스에서는 해당 정보를 바탕으로 올바른 요청인지 여부를 판단하며, 비정상적인 ID / Secret 입력시 에러를 전달합니다.
해당 정보는 프로젝트별 고유한 값이 발급되며, 해당 정보가 노출되어 서비스 제공에 문제가 발생된 경우 공식계정 메일(developers@kia.com)로 문의 부탁드립니다.
디벨로퍼스에서는 특정한 API 호출에 대한 응답 결과를 Redirect URL / Callback URL로 전달하고 있으니, 정상적인 응답값을 전달받기 위해서는 해당 URL 정보가 반드시 필요합니다.
기아 통합계정은 OAuth 2.0 을 지원하고 있습니다. 각각의 URL 정보는 아래와 같은 역할을 합니다.
계정 API - Redirect URL : 개인정보 제공 동의 요청 API를 호출할 때, 제3자 제공 동의 페이지에서 고객이 동의를 완료하면 리턴 값 (Authorization Code)을 전달받기 위해 설정하는 URL 입니다.
데이터 API - Redirect URL : 개인정보 제공 동의 요청 API 호출을 통해 연결된 제3자 제공 동의 페이지에서 사용자가 동의를 완료하는 경우, 리턴 값을 전달받기 위해 설정하는 URL 입니다.
데이터 API - Callback URL : 커넥티드 서비스 해지, 차량 삭제, 제3자 제공 동의 철회 등 고객 요청에 의해 데이터를 더 이상 제공할 수 없는 경우 이 정보를 전달받기 위해 설정하는 URL 입니다.
B2B 관련 설정 서버 IP / Admin Key : 해당 설정값들은 당사와 사업제휴를 통해 별도의 API 사용계약이 협의된 경우에만 표출되어 안내해드리고 있습니다.
주의 : 프로젝트의 Owner가 통합계정을 탈퇴하게 되는 경우, Owner로 등록된 프로젝트 정보도 삭제되어 서비스 이용이 불가능하게 됩니다.
API 관리 페이지에서 해당 프로젝트로 사용 권한이 부여된 API의 목록을 확인할 수
있습니다.
'개발 프로젝트' 에서는 사용 가능한 모든 API 의
승인여부를 안내하며, '상용화 프로젝트' 에서는 상용화
신청 시 승인된 API 들의 정보를 보여줍니다.
디벨로퍼스 사용자는 다음의 조건에 모두 해당하는 경우, 개발 단계에서 실제 차량을 연동할 수 있습니다.
1. 본인이 CCS (커넥티드 카 서비스, KIA Connect) 계약자로 등록된 차량에 대해
2. 해당 차량을 [내 차량 등록] 메뉴에서 '활성화' 한 경우
3. 해당 프로젝트에서 활성화 된 차량 데이터를 직접 조회할 수 있습니다.
차량의 본인 소유 여부와는 무관하며, 사용자 본인 명의로 CCS 가입이 된 차량에 한함
본인이 CCS 계약자로 등록된 차량을 보유하고 있는 경우, [내 차량 등록] 메뉴 접속시 해당 차량의 정보가 다음과 같이 조회됩니다.
원하는 차량의 활성여부를 선택하여 아래와 같은 약관에 동의하게 되면, 프로젝트와
차량의 연동이 시작됩니다.
차량 활성화 시에는 활성화에 따른 해당 차량 데이터의 프로젝트 멤버 간 공유 및
이용에 대한 서비스 약관 동의를 필수로 진행해야 합니다.
차량 연동이 완료된 이후 해제기능을 통해 연동을 중지할 수 있습니다.
차량 활성화 이후, 아래와 같은 프로세스로 계정 연동 및 차량 데이터를 호출 할 수
있습니다.
본인 차량 연동기능은 개발 프로젝트에서만 지원 가능하며, 상용화 이후에는 정상적인
동의절차를 거쳐 대고객 차량 접근이 가능합니다.
(자세한 설명은 API 활용하기 가이드를 참조해주세요.)
1. 계정 API를 통해, 기아 통합계정 연동 (활성화된 차량과
연동된 CCS 계정으로 로그인) 하여 해당 차량 선택
2. access token 획득
3. 개인정보 제공 동의 API를 통해 제3자 제공 동의 진행
4. 내 차량 리스트 조회 API를 통해 carID 획득
5. access token 정보와 carId 를 통해 차량 데이터 API 호출
해당 차량은 프로젝트와 연동된 것이므로, 동일한 프로젝트에서는 연동된 실제 차량 데이터를 위와 같이 호출할 수 있습니다.
동일한 프로젝트 멤버간의 통합계정 공유를 통한 연동차량 데이터 조회는 사용자의 자유이며, 이에 따른 책임은 본인에게 귀속됩니다.
콘솔 내 우측 상단 기술지원요청 버튼을 디벨로퍼스 이용과 관련된 문의를 하실 수
있습니다.
문의유형은 아래와 같이 4가지 유형으로 구분되어 있으며, 관리자가 답변을 완료한
문의건에 대해서는 내 문의 이력 페이지를 통해 확인하실 수 있습니다.
기술지원 요청을 통해 등록된 문의는 디벨로퍼스 관리자가 확인하고 빠르게 답변드리겠습니다.
디벨로퍼스를 통해 제공되는 API들에 대한 규격 변경 및 서버작업, 서비스 관련 공지는 콘솔 내 API 변경 공지 메뉴를 통해 전달됩니다. 서비스 관련 중요 전달사항에 대해서는 콘솔 내 공지 및 사용자 메일을 통해서도 전달될 예정이니, 관련 내용 확인하시어 디벨로퍼스 서비스 이용에 문제가 없도록 부탁드립니다.