플레이어 생성

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

플레이어를 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v1/players

요청 헤더

Video Player Enhancement API에서 공통으로 사용하는 헤더에 대한 정보는 Video Player Enhancement 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
auto_update String Optional 플레이어 SDK 자동 업데이트 여부
  • Y | N (기본값)
    • Y: 사용
    • N: 사용 안 함
domains Array Required 사이트 도메인 목록: domains
name String Required 플레이어 이름
  • 영문자, 숫자, 특수 문자 '_', '-', '@'를 허용하며, 3~30자 이내로 입력
  • 문자열 시작은 영문자로 구성
  • 중복 및 유효성 검증: 플레이어 이름 체크 참조
version String Optional 플레이어 SDK 버전

domains

domains에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
type String Required 사이트 도메인 유형
  • web | ios | aos
    • web: 웹사이트 URL
    • ios: iOS 앱 패키지 아이디
    • aos: Android 앱 패키지 아이디
domain String Required 도메인 또는 모바일 앱 패키지 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://vpe.apigw.ntruss.com/api/v1/players' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR' \
--data '{
    "auto_update": "Y",
    "domains": [
        {
            "domain": "https://www.example.com",
            "type": "web"
        }
    ],
    "name": "player001"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code String - 응답 코드
message String - 응답 메시지

응답 상태 코드

Video Player Enhancement API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Video Player Enhancement 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "200",
    "message": "ok"
}