Kollus VOD API v3 Migration Guide
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.
This guide provides key changes and endpoint mapping information for customers using Kollus VOD API v1, v2 to smoothly transition to v3. Review the 5 key changes below first, then proceed by navigating to the detailed mapping page for each feature through the Endpoint Index by Feature.
Kollus VOD API v1, v2 will be fully discontinued as of December 31, 2026. To maintain uninterrupted service, please complete the migration to v3 before the deadline.
Key Changes
These are the most important changes that apply commonly to all endpoints. They should be reflected first when designing your migration code.
1. Base URL Changes
The host domain for all APIs except the upload endpoint has changed.
- Before (v1):
api.kr.kollus.com/0 - Before (v2):
api-vod-kr.kollus.com/api/v0 - After (v3):
c-api-kr.kollus.com/api - Note: The upload feature uses a separate host,
upload.kr.kollus.com.
2. Standard HTTP Method Application
The structure has transitioned from v1's unidirectional POST approach to HTTP methods aligned with RESTful standard specifications.
- Retrieve:
GET - Create:
POST - Update:
PUT - Delete:
DELETE
3. Identifier Type Change (Integer → String)
The identifier (ID) format for all resources has changed from integer to string (Key) format, and language codes and other elements now follow standard specifications.
media_content_id(Integer) →upload_file_key(String)media_profile_id(Integer) →media_profile_key(String)language_id(e.g.,2) →language_code(e.g.,"ko")
4. Response Structure and Success Criteria Changes
The method of determining success has been unified to use HTTP status codes, and the response data structure (format) has been simplified.
- Success determination: Previous
error === 0check → HTTP status code (200 or 201) check - Response format:
{ error, message, result }→ wrapped in{ data }structure
The error: 1 within an HTTP 200 response rule applies only to v1. v2 responds with standard HTTP status codes (404, 422, etc.) and a Laravel-style { message, errors } structure.
5. Path Parameter Structure Changes
When setting up relationships between channels and content, the identifier interaction that was previously included in the request body has changed to the URL path structure.
- Before (v1/v2):
channel_keyinformation was sent included in the request body - After (v3): Request with both
channel_keyandupload_file_keyincluded as URL path parameters (See Also: Channel Management)
Endpoint Index by Feature
Select the category of the feature that needs migration to navigate to the detailed mapping page. Each detailed page prioritizes providing changes compared to the previous version.
| Category | Included Features | Notes |
|---|---|---|
| Common | Country, language, timezone list lookup | Country and timezone list lookup is a new feature in v3 |
| Category Management | Category list lookup/create/update/delete, channel link/unlink | v2 only supports category-channel link/unlink features |
| Channel Management | Channel list lookup/create/update/delete, content or player skin linking, callback and security | Note the key location |
| Media Content Key Management | Content key information lookup, validation, content allocation | The content key replacement feature has been discontinued in v3 |
| Media Authentication Management | Kollus encryption, custom key create/reissue/delete, watermarking identification code lookup | Not supported in v2 |
| Content Management | Content list lookup/detail lookup, update/delete, activate/deactivate, category change, upload URL generation, poster/original file download | Metadata lookup/update, snapshot create/download (v2 only) features have been discontinued in v3 |
| Transcoding Management | Transcoding progress status lookup, additional transcoding task creation, transcoding file lookup/download/activate/deactivate/delete | Not supported in v2 |
| AI Services | AI Subtitle generation, AI Summary lookup/generation, AI Speed conversion | New feature in v3 |
| Subtitle Management | Subtitle list lookup/detail lookup, register/upload/update/delete, display order change, supported language list lookup | Direct text input registration and subtitle detail lookup are supported starting from v2 |
| Bookmark Management | Bookmark list lookup (based on upload file key/media content key), add/update/delete | Not supported in v1; v2 supports only limited list lookup |
| Encoding Profile Management | Supported specifications/presets/groups lookup, profile list lookup/detail lookup/create/update, category link/unlink | Not supported in v2 |
| Concurrent Playback Prevention Management | Concurrent playback prevention log lookup, allowed device lookup/delete/full reset | New feature in v3 |
| Player Management | Player skin list lookup/delete, player event list lookup/delete | New feature in v3 |
| Statistics | Overall/channel content viewing ranking lookup, daily statistics lookup | Viewing ranking lookup uses result_data as the top-level key |
| Tag Management | Content list lookup by tag, tag add/remove | v1 only |
Migration Technical Support
If you encounter any issues or have questions during the migration process, please contact Kollus Technical Support(tech_support@catenoid.net). For prompt and accurate support, please include the required information below when reaching out.
Required Information
- Current API version in use (v1 or v2)
- Endpoint URL where the issue occurs
- Error logs, response messages, and reproduction steps