Video Player Enhancement overview

Prev Next

Available in Classic and VPC

Video Player Enhancement is a NAVER Cloud Platform service that enables you to play media content such as video and audio in web or mobile applications. The Video Player Enhancement service provides player creation, management, and viewing features in the RESTful API form.

Common Video Player Enhancement settings

The following describes commonly used request and response formats in Video Player Enhancement APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://vpe.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 Required 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

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
200 200 ok Call successful
200 200 Unauthorized The service is not subscribed.
200 4100 No version information. No player version information
200 4601 Query string player_no is missing. Player number entered incorrectly
200 4610 Query string name is invalid. Name entered incorrectly
200 4700 Body (JSON) name is missing. Request body name missing
200 4702 Body (JSON) domains is missing. Request body domain missing
200 4703 Some domains in Body (JSON) domains are invalid. (if type is web) Some domain errors in the request body (if web type)
200 4705 Some types in Body (JSON) domains are invalid. Some type of error in the request body domain
200 4706 Enter an option value for Body (JSON). The request body requires an option value to be entered.
200 4707 Body (JSON) pricing is missing or invalid. Missing or invalid pricing in the request body
200 4708 There are duplicate domains in Body (JSON) domains. Duplicate domains exist in the request body.
200 4709 Up to 5 domains can be added to Body (JSON) domains. Only up to 5 domains can be added to the request body.
200 4711 Only 1 Body (JSON) app per OS can be added. Only one app per operating system can be added to the request body.
200 4712 At least 1 Body (JSON) web domain must be added. At least one web domain must be added to the request body.
200 4713 Body (JSON) name or web domains cannot be edited. Request body name or web domain can't be edited.
200 4729 Body (JSON) customBtns must be array. The customBtns field must be an array type.
200 4730 Body (JSON) customBtns is up to 4. Only up to 4 customBtns fields can be set.
200 4731 Body (JSON) customBtns position is invalid. The position of the customBtns field is invalid.
200 4732 Body (JSON) customBtns position is required. The position of the customBtns field is missing.
200 4733 Body (JSON) customBtns icon is required. The icon of the customBtns field is missing.
200 4734 Body (JSON) customBtns ui is required. The UI of the customBtns field is missing.
200 4735 Body (JSON) customBtns ui is invalid. The UI of the customBtns field is invalid.
200 4736 Body (JSON) customBtns flow is invalid. The flow of the customBtns field is invalid.
200 4799 Enter an option value for Body (JSON). The request body requires an option value to be entered.
200 4800 No player has been added. No player has been added.
200 4801 No player information. No player information
200 4802 This player already exists. The player already exists.
200 4803 The number of players exceeded the limit. For free, limit 1
200 4804 The feature can't be used in the free version of player. Unavailable in free version
200 4805 The player name already exists. The player name already exists.
400 100 when page_no is too large, the error msg is page_no exceeds the size limit.
when page_size is too large, the error msg is page_size exceeds the size limit.		 Page number is too large or page size is too large.
401 200 Authentication Failed Authentication failed
401 210 Permission Denied Unauthorized
404 300 Not Found Exception Unauthorized
429 400 Quota Exceeded Quota exceeded
429 410 Throttle Limited Rate exceeded
429 420 Rate Limited Rate exceeded
413 430 Request Entity Too Large Request entity size limit exceeded
503 500 Endpoint Error Endpoint connection error
504 510 Endpoint Timeout Endpoint connection time limit exceeded
500 900 Unexpected Error Error not handled as an exception
Note

For information about the HTTP status codes common to all NAVER Cloud Platform, see Ncloud API response status codes.

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":"210",
        "message":"Permission Denied"
    }
}

Video Player Enhancement API

The following describes the APIs provided by the Video Player Enhancement service.

API Description
Create a player Create a player to play media content in a web or mobile application.
Duplicate player Create a new player by duplicating an existing player.
Get player SDK version Get available player SDK versions.
Check player name Check validity and duplication of player name.
Get player list Get player information list.
Get player options Get player option information.
Get player Get player details.
Roll back player (develop) Roll back player settings deployed to the develop environment.
Deploy player (develop) Deploy player settings to the develop environment.
Deploy player (production) Deploy player settings to the production environment.
Edit player Deploy the player's site domain modification to the production environment.
Delete a player Delete a player.

Video Player Enhancement related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Video Player Enhancement APIs.