Integration Settings

Printer-friendly version
Audience / Tech Expertise: 

Integration Settings

This tab displays the Integration settings for the KMC. Integration settings contain the information that provides unique IDs to Kaltura, including your Partner ID, which is your site’s identification and ticket to the Kaltura platform and API. Your Partner ID enables you to connect to Kaltura, display media, upload media and experience all of Kaltura’s functionality.

Account Info

The account info displays account information. The Partner ID is your Kaltura account identification number. The Sub Partner ID is generally deprecated and kept for backward compatibility of older Kaltura based applications.

The Administrator Secret and User Secret are the API private keys used to generate authentication tokens for sessions with the Kaltura servers when using the API. Since the keys can be used to run API commands on your content in Kaltura, you should keep these secret. Usually, the user secret is enough for all activities and therefore this is the key that should be provided to parties wishing to access your Kaltura account via API. The Admin Secret can be used to login as an administrator, and therefore can be used to perform any action on your account.

For more information, please refer to the Kaltura API documentation.

Notifications

When creating Kaltura applications or integrating various Kaltura features into existing applications or sites, it is often required that the application be notified of various actions that occurred in Kaltura. For example: When a user on your site uploads a new video file, you might want your site code to be notified of when Kaltura has finished processing the video file and made it ready for publishing.

While it is possible to easily query the Kaltura API periodically, Kaltura’s API Notifications utilize a “push” methodology where a code on your site will be called automatically by Kaltura whenever certain actions occur like video upload or media status changes.

Entitlement Settings

The Entitlement Settings option in the Integration Settings page is available with entitlement account configuration only. Entitlement settings may be added to categories integrated in applications to support content entitlement. You can control the entitlement settings that are added and enforced to selected categories in your account.  

Adding Entitlement to Categories

Use the "Privacy Context" to add entitlement to categories.

Privacy Context is a free text label that indicates to which application the entitlement settings apply, for example, “MediaSpace”.The Privacy Context label is used for specific indexing of categories and content associated with it, and should also be configured in the application session (KS) itself.  The Privacy Context configuration for an application guarantees the following:

  • User’s entitlements to content in the application are determined based on the specific categories the application is integrated with. 
  • Categories that are not directly integrated with the application can be used for any content organization and applicative classification purposes. A content item can be shared with such categories with no impact on their visibility to end-users through the application.

In the common case, a single Privacy Context should be set to an entire ‘branch’ within the category-tree, and indicate the application integrated with it.

In more complex scenarios, multiple privacy contexts can be set to categories to enable access to content shared between multiple applications within the account, and under the same organizational context.

The Privacy Context is set to categories as part of the MediaSpace installation process. Following this configuration, the MediaSpace categories can be edited to include entitlements settings. For any other purposes, entitlements and privacy context can be added to categories from the Integration Settings page in the KMC. 

See How to Add Entitlements to Categories for more information.

Back

Document type: 
(1706 reads)