Set up an MRSS import feed

If you have a valid Media Really Simple Syndication (MRSS) feed for your collection of videos, you can bulk import those videos and associated content into your account.

Using the Platform Management API, you can create an import feed with a single API call. When an MRSS import feed is active, JW Player checks for new content to import every 5 minutes.

👍

IMPORTANT

Be sure to limit your MRSS feed to 1,000 media. If you have more than 1,000 media in your feed, split them into groups of 1,000 or less.

📘

TIP

You can also learn How to Import Content in Bulk Using MRRS Feeds from your JW Player dashboard.



Requirements

  • Property ID
  • Media RSS Feed URL
  • MRSS feed authentication credentials, if required


Create the JSON payload

Use the following steps to build the JSON payload within the metadata object to set up a new feed:

  1. Add the url, title, and state of the MRSS feed.
{
    "metadata": {
        "url": "{mrss_feed_url}",
        "title": "This is a Test Feed",
        "state": "importing"
    }
}
  1. Define how the media should be handled when imported (host_on_import) to your JW Player account:

    true: (Recommended) This option uploads and registers each video to your account. You can share, edit (including video length, captions, metadata), recommend, monetize, and analyze each video.

    false: This option only registers each video with your account. You can share, edit only video metadata, recommend, and analyze each video. This option limits access to various data products and features. Use this option when adding videos with embedded captions to your library. Videos using this option are not subject to monthly storage or streaming limits.

  2. If authentication is required to access the content to import, set the username and password.

  3. In an array of string values, add any tags to be applied to the media upon import. These values are added as media tags, used for searching, sorting and filtering JW Player playlists.

  4. If the MRSS feed has namespaced tags, define all tags in the ingest_tags array of string values. These values are added as media tags, used for searching, sorting and filtering JW Player playlists. Standard MRSS tags should not be used.


Sample JSON Payload

The following is a sample complete JSON payload.

{
    "metadata": {
        "url": "https://my.mrss-feed.com?format=mrss",
        "title": "Millzville Film Festival",
        "state": "importing",
        "host_on_import": true,
        "username": "myusernme",
        "password": "[email protected]$$worD",
        "tags": ["movies", "trailers"],
        "ingest_tags": ["jw:film-festival", "jw:day1"]
    }
}

Create and initiate the feed import

  1. Create a POST https://api.jwplayer.com/v2/sites/{site_id}/imports/ call. Be sure to replace {site_id} with a site ID.
  2. Add the API authentication.
  3. Add the JSON payload.
  4. Initiate the API call.

The JW Platform Management API v2 creates a new import resource that begins to import your media. In addition to your defined tags, ingest_tags, and standard metadata (ingest_metadata), the following table lists the three import feed-related custom_params that are associated with each ingested media.

custom_params keyDescription
import_guid stringGUID of the MRSS feed
import_id stringUnique ID of the import
mrss_video_url stringURL of the ingested media file




📘

MORE INFORMATION

Review the imports route reference to learn about the available import API calls to manage import feeds.

Be mindful that any configuration changes will not apply retroactively to assets that have already been ingested.



Did this page help you?