카테고리 생성
    • PDF

    카테고리 생성

    • PDF

    기사 요약

    VOD Station은 카테고리를 생성하기 위한 API를 제공하며 생성한 카테고리 조회를 위해 카테고리 목록 조회 API카테고리 정보 조회 API를 제공합니다.

    요청

    POST https://vod-station.apigw.gov-ntruss.com/api/v2/category
    

    요청 헤더

    헤더명설명
    x-ncp-region_code네이버 클라우드 플랫폼 region code
    x-ncp_region_code:{Region Code}
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 표현
    API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 바디

    API 요청 시 필드명의 대소문자 구분이 필요합니다.

    필드명필수 여부타입제약 사항기본 값설명
    nameYesString- 생성할 카테고리의 이름
    output.bucketName에 카테고리 명의 폴더 자동 생성
    encodingOptions[]NoArray(Integer)NULL카테고리에 설정할 인코딩 옵션
    encodingOptionTemplateIdNoInteger- 인코딩 템플릿 ID
    인코딩 템플릿 조회를 통해 확인한 ID를 입력
    템플릿에 포함된 encodingOptionId를 encodingOptions[] 필드 값으로 설정
    encodingOptions[] 필드 값으로 템플릿 내 encodingOptionId외 다른 ID를 설정 불가
    thumbnailNoBooleantrue, falseFALSE썸네일 추출 설정
    notificationUrlNoStringCallback URL 설정
    outputYesObject카테고리 출력 설정
    output.bucketNameYesString출력 버킷 이름
    output.filePathYesString최소 1자, 최대 256자까지 입력 (영문, 숫자, < > : " / \ ? * % 제외 특수문자 허용)출력 파일을 업로드 할 상세 경로
    output.thumbnailBucketNameOptionalString입력하지 않을 시 output.bucketName 설정을 따름썸네일 출력 버킷 이름
    output.thumbnailFilePathOptionalString입력하지 않을 시 output.filePath 설정을 따름
    최소 1자, 최대 256자까지 입력 (영문, 숫자, < > : " / \ ? * % 제외 특수문자 허용)
    썸네일 출력 파일을 업로드 할 상세 경로
    output.accessControlNoStringPUBLIC_READ, PRIVATEPRIVATE출력 파일의 공개 범위
    output.thumbnailAccessControlNoStringPUBLIC_READ, PRIVATEPRIVATE출력 썸네일의 공개 범위
    advancedOptionsNoObjectNULL고급 설정
    advancedOptions.trimmingNoObjectNULL출력 파일 트리밍 설정
    advancedOptions.trimming.startTimeCodeYesString포맷: "HH:MM:SS.S"- 트리밍 시작 시점
    타임코드 포맷에 맞춰 값 입력
    advancedOptions.trimming.endTimeCodeYesString포맷: "HH:MM:SS.S",
    startTimeCode보다 작은 값 입력 불가
    - 트리밍 종료 시점
    타임코드 포맷에 맞춰 값 입력
    advancedOptions.imageOverlayNoObjectNULL이미지 오버레이 설정
    advancedOptions.imageOverlay.inputYesObject입력 이미지
    advancedOptions.imageOverlay.input.bucketNameYesString입력 이미지가 업로드 되어있는 버킷 이름
    advancedOptions.imageOverlay.input.filePathYesString파일명을 포함한 입력 이미지의 상세 경로
    advancedOptions.imageOverlay.positionYesObject삽입할 이미지 위치 설정
    advancedOptions.imageOverlay.position.xYesIntegerx 축 위치
    advancedOptions.imageOverlay.position.yYesIntegery 축 위치
    advancedOptions.imageOverlay.sizeYesObejct삽입할 이미지 크기 설정
    advancedOptions.imageOverlay.size.widthYesInteger이미지 너비
    advancedOptions.imageOverlay.size.heightYesInteger이미지 높이

    응답

    필드명타입설명비고
    errorObject요청 실패시 응답
    오류 응답 코드 및 메시지
    error.codeInteger오류 응답 코드
    error.messageString오류 응답 메시지
    contentObjectVOD Station OPEN API 응답 객체
    content.idString생성된 카테고리의 ID
    content.nameString카테고리 이름
    content.encodingOptions[]Array(Integer)인코딩 옵션 ID
    content.encodingOptionTemplateIdInteger인코딩 템플릿 ID
    content.thumbnailBoolean썸네일 추출 설정
    content.notificationUrlStringCallback URL 설정
    content.outputObject출력 설정
    content.output.bucketNameString출력 버킷 이름
    content.output.filePathString출력 파일을 업로드 할 상세 경로
    content.output.thumbnailBucketNameString썸네일 출력 버킷 이름
    content.output.thumbnailFilePathString썸네일 출력 출력 파일 업로드 상세경로
    content.output.accessControlString출력 파일의 공개 범위
    content.output.thumbnailAccessControlString출력 썸네일의 공개 범위
    content.statusString카테고리 상태CREATED, DELETED, RUNNING
    content.createTimeInteger카테고리 생성 시간
    content.updateTimeInteger카테고리 수정 시간
    content.disabledBooleansubaccount 제공 필드
    해당 리소스가 subaccount에서 활성 여부
    content.outputTypeInteger설정된 인코딩 설정에 따른 출력 타입 개수
    content.advancedOptionsObject고급 설정
    content.advancedOptions.trimmingObject출력 파일 트리밍 설정
    content.advancedOptions.trimming.startTimeCodeString트리밍 시작 시점
    content.advancedOptions.trimming.endTimeCodeString트리밍 종료 시점
    content.advancedOptions.imageOverlayObject이미지 오버레이 설정
    content.advancedOptions.imageOverlay.inputObject입력 이미지
    content.advancedOptions.imageOverlay.input.bucketNameString입력 이미지가 업로드 되어있는 버킷 이름
    content.advancedOptions.imageOverlay.input.filePathString입력 이미지의 상세 경로
    content.advancedOptions.imageOverlay.positionObject삽입할 이미지 위치 설정
    content.advancedOptions.imageOverlay.position.xIntegerx축 위치
    content.advancedOptions.imageOverlay.position.yIntegery축 위치
    content.advancedOptions.imageOverlay.sizeObejct삽입할 이미지 크기 설정
    content.advancedOptions.imageOverlay.size.widthInteger이미지 너비
    content.advancedOptions.imageOverlay.size.heightInteger이미지 높이

    예시

    요청 예시

    POST https://vod-station.apigw.gov-ntruss.com/api/v2/category
    
    POST /api/v2/category
    HOST: vod-station.apigw.gov-ntruss.com
    Content-Type: application/json
    x-ncp-region_code:KR
    x-ncp-apigw-timestamp:1521787414578
    x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
    x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
    
    Reqeust body
    {
      "encodingOptions": [
        1, 2, 3
      ],
      "name": "3type-basic-category",
      "output": {
        "bucketName": "vs-output",
        "filePath": "/"
      },
      "thumbnail": false
    }
    

    응답 예시

    HTTP/1.1 200 OK
    Server: nginx
    Date: Wed, 12 Sep 2018 09:53:32 GMT
    Content-Type: application/json;charset=utf-8
    Connection: keep-alive
    Access-Control-Allow-Origin: *
    x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
    
    {
      "content": {
        "disabled": false,
        "id": 10095,
        "name": "3type-basic-category",
        "thumbnail": false,
        "output": {
          "bucketName": "vs-output",
          "filePath": "/"
        },
        "createTime": 1631594152000,
        "updateTime": 1631594152000,
        "status": "CREATED",
        "outputType": 3,
        "encodingOptions": [
          1,
          2,
          3
        ]
      }
    }
    

    Callback Body 예시

    {
      "categoryId":10268,
      "categoryName":"callback-test",
      "encodingOptionId":3,
      "fileId":10808,
      "filePath":"/.../Guide720_AVC_HD_1Pass_30fps.mp4",
      "outputType":"AVC_HD_1Pass_30fps",
      "status":"RUNNING"
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.