Skip to main content

Media Content Key Management

Notice

This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, refer to the Korean documentation.

Go to Media Content Key Management API v3 Reference
Feature scope by version
  • Retrieve content key information and assign: Supported only in v2 and v3.
  • Validate content key: Supported only in v1 and v3.
  • Exchange content key: Supported only in v1 and v2.
  • Common authentication: All API versions use a common authentication method via a query string parameter (?access_token=). For the common specification on error determination criteria, refer to the Core Changes section of the API v3 migration guide.

Retrieve media content key information​

  • Before (v2): GET /vod/media-content-keys/{media_content_key}
  • After (v3): GET /media-content-keys/{media_content_key}
Changes
  • Not supported in v1: This endpoint is not supported in v1.
  • Response field name change: The key field from v2 has been changed to media_content_key in v3.
  • Simplified response structure: In v2, the entire media_content and media_channel data was nested and returned in a hierarchical structure, but in v3, it is returned as a flat, one-dimensional data field structure, including upload_file_key and channel_key, to minimize bandwidth.
Response structure details

Response structure comparison​

  • v2
{
  "data": {
    "id": 12,
    "key": "string",
    "media_content": {
      "id": 34,
      "upload_file_key": "string",
      "title": "string"
    },
    "media_channel": {
      "id": 56,
      "channel_key": "string",
      "name": "string"
    }
  }
}
  • v3
{
  "data": {
    "id": 12,
    "media_content_key": "string",
    "upload_file_key": "string",
    "channel_key": "string",
    "status": true,
    "created_at": "string",
    "updated_at": "string"
  }
}

Validate media content key​

  • Before (v1): POST /media/media_content_key/validate
  • After (v3): GET /media-content-keys/validate
Changes
  • HTTP method change: The HTTP method has been changed from POST to GET.
  • Parameter transmission format change: In v1, values were passed in the request body as a comma(,)-separated text structure, but in v3, the request must be composed as a query string array structure (media_content_keys[]=A&media_content_keys[]=B).
Request parameter transmission format and response structure details

Request parameter transmission format comparison​

Itemv1 specificationv3 specification
Transmission areaRequest bodyQuery string
Parameter namemedia_content_keysmedia_content_keys[]
Value structureString (e.g., "mck_key_A,mck_key_B")Array (e.g., media_content_keys[]=mck_key_A&media_content_keys[]=mck_key_B)

Response structure comparison​

The dynamic data expansion pattern, in which the requested key itself is declared as the response data field name, remains the same.

  • v1
{
  "error": 0,
  "result": {
    "mck_key_A": true,
    "mck_key_B": false
  }
}
  • v3
{
  "data": {
    "mck_key_A": true,
    "mck_key_B": false
  }
}

Assign media content key​

  • Before (v2): PUT /vod/media-contents/{upload_file_key}/assign-media-content-key
  • After (v3): PUT /media-contents/{upload_file_key}/media-content-keys/{media_content_key}/assign
Changes
  • Not supported in v1: This endpoint is not supported in v1.
  • Parameter transmission path change: In v2, the content key (media_content_key) item was passed in the request body, but under the v3 migration guideline specification, all target identifiers have been unified into the URL path structure.
  • Enhanced response data format: v3 returns a data structure that includes standardized status codes.
Request parameter and response structure details

Request parameter configuration and path comparison​

Itemv2 specificationv3 specification
upload_file_keyURL path parameterURL path parameter (placed first)
media_content_keyRequest bodyURL path parameter (placed second)

Response structure specification​

{
  "data": ApiVodMediaContent object,
  "status": "ok"
}

Exchange media content key​

  • Before (v1): POST /media/channel/change_media_content_key/{media_content_key}
  • Before (v2): PUT /vod/media-content-keys/{media_content_key}/exchange-key
  • After (v3): Not supported
Official API deprecation notice

The content key exchange feature provided in v1 and v2 has been completely deprecated in the v3 specification.