플레이어 조회

Prev Next

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

플레이어의 사이트 도메인, Access Key 등 상세 정보를 조회합니다.

요청

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

메서드 URI
GET /api/v1/players/{player_no}

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
player_no String Required 플레이어 번호

요청 예시

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

curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/6159' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code String - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.name String - 플레이어 이름
result.no String - 플레이어 번호
result.version String - 플레이어 SDK 버전
result.domains Object - 사이트 도메인 정보
result.domains.aos Array - Android 앱 패키지 정보: 도메인 정보
result.domains.ios Array - iOS 앱 패키지 정보: 도메인 정보
result.domains.web Array - 웹사이트 도메인 정보: 도메인 정보
result.access_key String - 플레이어 Access Key
result.created_at String - 플레이어 생성 일시
  • ISO 8601 형식
result.updated_at String - 플레이어 수정 일시
  • ISO 8601 형식
result.auto_update String - 자동 업데이트 여부
  • Y | N
    • Y: 사용
    • N: 사용 안 함

도메인 정보

도메인 정보에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
no Integer - 도메인 식별 번호(Primary Key)
type String - 사이트 도메인 유형
  • web | ios | aos
    • web: 웹사이트 URL
    • ios: iOS 앱 패키지 아이디
    • aos: Android 앱 패키지 아이디
domain String - 도메인 또는 모바일 앱 패키지 아이디
created_at String - 도메인 등록 일시
  • ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
    "code": "200",
    "message": "ok",
    "result": {
        "name": "player000",
        "no": 6159,
        "version": "1.1.3",
        "domains": {
            "aos": [
                {
                    "no": 2393,
                    "type": "aos",
                    "domain": "*******",
                    "created_at": "2025-08-12T02:23:28.000+00:00"
                }
            ],
            "ios": [
                {
                    "no": 2392,
                    "type": "ios",
                    "domain": "com.t***.com",
                    "created_at": "2025-08-12T02:23:28.000+00:00"
                }
            ],
            "web": [
                {
                    "no": 2231,
                    "type": "web",
                    "domain": "https://************.***.kr",
                    "created_at": "2025-05-27T05:34:37.000+00:00"
                },
                {
                    "no": 2389,
                    "type": "web",
                    "domain": "http://main.***********.**.kr/",
                    "created_at": "2025-08-12T01:22:37.000+00:00"
                }
            ]
        },
        "access_key": "7848************************102d",
        "created_at": "2025-05-27T05:34:37.000+00:00",
        "updated_at": "2025-08-12T02:23:31.000+00:00",
        "auto_update": "N"
    }
}