Skip to content

VideoEnd API

hw.c edited this page May 8, 2020 · 2 revisions

2020.05.09 API spec 회의

영상 상세 화면에서 요청할 API spec에 대해 다루는 문서


Index

영상 상세 화면에 진입 시 요청할 API 목록

  • VideoEnd API : 영상 상세 진입 시 화면 구성에 필요한 영상 정보를 가져오는 API
  • Channel API : 영상 상세 진입 시 화면 구성에 필요한 채널 정보를 가져오는 API
  • VideoList API : 영상 상세 진입 시 화면 구성에 필요한 관련영상/추천영상 리스트를 가져오는 API
    • 채널 기반 관련영상
    • 영상 기반 추천영상

영상 상세 화면에서 사용자 인터렉션으로 인해 요청이 필요한 API 목록


VideoEnd API

(가제)


Overview

영상 상세(VideoEnd) 진입 시 화면 구성에 필요한 영상 정보를 가져오는 API


1. URL

// TBD

GET /videoend

2. Parameters

Path Parameter

// TBD

URL Parameter

// TBD

Data Params

none

3. Simple Call

// TBD

4. Response

Success

// TBD

Error

// TBD

response는 다음과 같이, 재생할 영상 정보 및 좋아요/하이라이트 정보로 구성된다.
- 재생할 영상 정보
- 하이라이트 리스트 (10개)
- 좋아요 수 / 좋아요 여부




Channel API

(가제)


Overview

VideoEnd 및 ChannelEnd 진입 시 화면 구성에 필요한 채널 정보를 가져오는 API


1. URL

// TBD

GET /channel

2. Parameters

Path Parameter

// TBD

URL Parameter

// TBD

Data Params

none

3. Simple Call

// TBD

4. Response

Success

// TBD

Error

// TBD

response는 다음과 같이, 채널 정보 및 팬 정보로 구성된다
- 채널 정보 (채널명/profileImage/...)
- 팬 수 / 팬 여부