Video Sources Collection


List Video Sources

GET https://api.zype.com/video_sources

Parameters

Parameter Function Type
page The page number of records to return (Example: 1) Integer
per_page The number of records to return (Example: 10) Integer
q Filter records by keyword String
type The type of video sources to query. Example: zype, hulu, youtube, crunchyroll String
id Query for a video source by id String
id! Exclude records by ID String

Retrieve a Video Source

GET https://api.zype.com/video_sources/[id]

Parameters

Parameter Function Type
id ID of the record (Example: 5389352e69702d401b000000) String

Create a Video Source

POST https://api.zype.com/videos_sources

Only MRSS video sources may be created via the API at this time.

Parameters

Parameter Function Type
video_source[name] Name of the video source String
video_source[url] MRSS feed URL String
video_source[category_id] Category ID assigned to the video source String
video_source[mrss_category_values][] Assign values from a Category Array
video_source[sync_interval] How often this video source should sync with the MRSS feed (daily / hourly) String
video_source[auto_add] Automatically add new video imports to your video library as the feed is synced Boolean
video_source[auto_activate] Automatically activate new videos added to your video library Boolean
video_source[auto_deactivate] Automatically deactivate video data sources that are absent from this feed that have been previously imported Boolean
video_source[sync_video_data_source] Automatically update video source attributes such as thumbnails and video files Boolean
type Specify the type of Video Source. Options are ‘mrss’, ‘hulu’, ‘crunchyroll’, ‘kaltura’, ‘vimeo’, ‘vimeo_pro’, ‘youtube’, ‘youtube_playlist’, ‘youtube_video’, ‘zype’, and ‘zype_msl’ String
video_source[import_from] Exclude videos published before this date Date
video_source[import_to] Exclude videos published after this date Date

Update a Video Source

PUT https://api.zype.com/videos_sources/[id]

Every video source can update its name and guid (if the source has one). Other attributes may only be updated for MRSS video sources as detailed below.

Parameters

Parameter Function Type
video_source[id] ID of the record String
video_source[name] Updated name of the video source String
video_source[guid] Updated guid given for the video source String

MRSS video sources also have the ability to update the following:

Parameter Function Type
video_source[url] MRSS feed URL String
video_source[category_id] Category ID assigned to the video source String
video_source[mrss_category_values][] Assign values from a Category Array
video_source[sync_interval] How often this video source should sync with the MRSS feed (daily / hourly) String
video_source[auto_add] Automatically add new video imports to your video library as the feed is synced Boolean
video_source[auto_activate] Automatically activate new videos added to your video library Boolean
video_source[auto_deactivate] Automatically deactivate video data sources that are absent from this feed that have been previously imported Boolean
video_source[sync_video_data_source] Automatically update video source attributes such as thumbnails and video files Boolean
video_source[import_from] Exclude videos published before this date Date
video_source[import_to] Exclude videos published after this date Date

Delete a Video Source

DELETE https://api.zype.com/video_sources/[id]

Parameters

Parameter Function Type
id ID of the record to delete (Example: 5389352e69702d401b000000) String

Video Source Object

{
  "_id": "5468f40d4c616e0a770d0000",
  "created_at": "2014-11-16T13:59:25.420-05:00",
  "deleteable": false,
  "editable": false,
  "name": "Zype",
  "provider_id": "5429b1ca69702d2f7c190000",
  "refreshed_at": null,
  "site_id": "5468f40d4c616e0a770c0000",
  "updated_at": "2014-11-16T13:59:25.420-05:00",
  "video_count": 0
}