VOD Station overview

Prev Next

Available in Classic and VPC

VOD Station is a NAVER Cloud Platform service dedicated to VOD that provides encoding features that convert stored videos to be viewed on various devices, and streaming features that packetize video files to efficiently use the network. The VOD Station service provides video encoding and streaming features in the form of RESTful APIs.

Common VOD Station settings

The following describes commonly used request and response formats in VOD Station APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://vodstation.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
Content-Type Optional Request data format
  • application/json
x-ncp-region_code Optional Region code
  • KR: Korea (valid value)

Response

The following describes the common response format.

Response body

The response body includes the following data:

error

error defines the API call failure information. The following describes error.

Field Type Required Description
error Object - Error code and message
error.errorCode String Required Error code
error.message String Required Error message
error.details String Required Error message details

Response status codes

See the following for response status codes common to all VOD Station APIs.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
    "error": {
        "errorCode": "300",
        "message": "Not Found Exception"
    }
}

VOD Station API

The following describes the APIs provided by the VOD Station service.

Channel

The following describes the channel-related APIs.

API Description
Create channel Create VOD streaming channel.
Get channel list Get VOD streaming channel list.
Get channel event Get event occurred in VOD streaming channel.
Get channel Get VOD streaming channel details.
View protocol list Get supported streaming protocols.
Start channel Start VOD streaming channel.
Stop channel Stop VOD streaming channel.
Change channel CDN Change VOD streaming CDN.
Delete channel Delete VOD streaming channel.

Category

The following describes the category-related APIs.

API Description
Create category Create category for encoding video file.
Get category list Get 2 or more category lists.
Get category Get category details.
Edit Category Edit category details.
Add category file Add encoding file in category.
Delete category Delete created category.
Use category callback Set up a callback to check the status of encoding request.

Encoding Option

The following describes the APIs related to encoding options.

API Description
Create encoding option Create encoding options for converting video files.
Get encoding option list Get 2 or more encoding option lists.
Get encoding options Get encoding option details.
Get encoding option template list Get 2 or more encoding template lists.
Delete encoding option Delete created encoding option.

Status

The following describes the status-related APIs.

API Description
Get category status list Get encoding status list by category.
Get category status Get category encoding status details.
Get category statistics Get category encoding file statistics.

VOD Station related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand VOD Station APIs.