with-lab소개 > OPEN API 이용 절차

KBS with open API를 이용한 개발 프로세스는 다음과 같습니다.


1. 등록

1)Client ID  를 만든다.
-- with-lab 회원 가입을 통해 사용자 계정을 만들면 발급됩니다.

2)Client Secret 을 만든다.
-- Client ID와 마찬가지로 with-lab 회원 가입을 통해 사용자 계정을 만들면 발급 받을 수 있습니다.

3)AppID 를 등록한다
-- 인드로이드 마켓이나 애플 마켓에 앱을 등록 할때 사용하는 앱의 아이디 입니다.
-- 앱 등록 및 관리 (https://withlab.3scale.net/registerapp)에서 새어플리케이션 등록을 통해 AppID를 입력합니다.  
-- 등록에서 중요한 것은 앱ID와 앱버전 그리고 플랫폼입니다.

위의 정보중 1)과 2)는 아래 설명하는 모든 API 호출시 항상 전송해야하는 내용입니다.
위의 정보중 3) 앱 아이디는 아래 설명하는 인증과정에서 앱이 등록된 앱인지를 확인하는데 필요합니다.

아래 부터는 앱을 개발할 때 신경 써야할 내용입니다.

2. 인증

1) checkAppVersion 을 호출하여 등록된 앱인 지를 확인합니다.
   위의 등록에서 등록 앱ID와 앱버전을 사용하여 등록 여부를 확인합니다.

2)사용자 인증
login 을 호출하여 앱을 사용하는사용자에 대한 인증을 합니다.
사용자라 합음 kba.co.kr에 등록된 아이디를 가지고 있는 사용자를 말합니다. 
인증이 완료되면 AuthKey가 리턴됩니다. 이건 아래 디바이스 인증을 위해서 필요합니다.
 AuthKey는 매번 발행됩니다.

3)디바이스 인증
-- isExistsDevice를 호출하여 등록된 앱인지를 확인합니다
  - 사용자인증에서 발급된 AuthKey와 디바이스의 고유정보인 DeviceKey를 사용합니다. 
  - isExistDevice를 사용하여 등록되지 않은 디바이스이면 registDevice를 호출하여 등록 처리를 합니다.
  - 위의 과정에서 중요한 정보는 등록 3)에서 입력한 앱아이디 앱버전 그리고 플랫폼 정보 입니다.



3. API 활용

3.1 채널정보

위의 인증이 모두 끝나면 KBS의 방송 프로그럼 정보를 확인하는 것부터 시작합니다.

1)주간편성정보
  주간편성정보를 조회 할 수 있습니다. 이번주 정보를 조회합니다., 매일매일 업데이트 되는 내용입니다.

2)일일편성정보
  오늘의 방송정보를 조회합니다. 1시간단위로 갱신되니 최신 정보라 할 수 있습니다.

3.2 VOD

위의 채널정보(실시간 방송정보) 이외에 vod정보를 조회할 수 있습니다.

1)검색어를 사용하여 VOD목록을 조회할 수 있습니다

2)위에서 검색한 VOD를 시청하게 되면 어떤 vod를 어디 까지 시청했는지에 대한 정보를 saveSeamlees AP를 사용하여 저정할 수 있습니다

3)getSeamlessListr를 사용하여 사용자가 시청하던 vod목록및 정보를 조회 할 수 있습니다. 선택하여 최근 시청위치 부터 바로 시청가능 하도록 하는데 사용합니다

3.3 세부정보

위에서 채널 정보를조회하여 실시간 스트리밍을 즐길 수 있고 VOD를 사용하여 VOD를 즐길수 있습니다.
시청중 해당 프로그램에 대한 부가 정보가 필요하다면 아래의 API를 조회하여 확인 할 수 있습니다.

1)자막정보
  프로그램의 자막을 조회할 수 있습니다 조회한후 동영상 뷰어에 자막을 보이게 하는데 활용 할 수 있습니다.

2)인물정보
  시청중인 프로그램의 현재 영상에 등장하는 인물정보를 구할 수 있습니다.

3)설문
  설문이 필요한 프로그램을 시정중에는 설문에 대한 API를 조회하여 프로그램의 해당 위치에서 팝업 시킬 수 있습니다.


4. 개발된 App 등록

개발이 완료된 App의 버전이나 App 소개 정보가 변경 되었을 경우
앱 등록 및 관리 (https://withlab.3scale.net/registerapp)에서 최초 App ID 발급을 위해 등록했던
어플리케이션 정보를 클릭하여 수정사항 입력합니다.