Kaltura Edition:
Kaltura SaaS
Kaltura Cloud Edition
Kaltura Community Edition
Kaltura On Prem
Minimum Kaltura Version:
Kaltura Dragonfly
Audience / Tech Expertise:
Extending Kaltura - Programming Using API and Plugins
Integration that Involves Programming
Getting started with the Kaltura API
- Start by reading about Kaltura's Architecture.
- As a reference for understaning technical terms related to Online Video, Media Asset Management and Kaltura - use the Kaltura Knowledge Center Glossary.
- For more information about using api_v3 refer to the Introduction to the Kaltura API Architecture.
- For further information on the API calls for Partner Services 3 (api_v3), please refer to the api_v3 API documentation (API Docs).
- Use the API Client Libraries to easily perform the API callbacks in your programming language of choice - Refer to the Kaltura API Client Libraries Guide for more.
- Learn about the differences between api_v2 and api_v3, and learn how to use the TestMe Console - read the Kaltura API and TestMe Console Introduction.
- If you use a CMS like Drupal and WordPress or and LMS such as Moodle, Sakai or Blackboard, make sure to check the Kaltura Exchange for a Kaltura integration to your CMS of choice.
Kaltura API Guides
The series of guides below are what we recommend as proper training steps in using Kaltura's API to integrate Kaltura functionality to websites and applications and create custom Kaltura applications.
Read the guides in-order, or find the specific answers you are looking for and let us know if we're missing a guide.
| Guide | Summary | What will you learn |
|---|---|---|
| Introduction to the Kaltura API Architecture | Kaltura provides server APIs for every core feature. You can use the Kaltura API to incorporate Kaltura features in web applications and web sites. | Learn the basics of the Kaltura API and API architecture. |
| Kaltura API Usage Guidelines | The Kaltura API is flexible, easy to access, and simple to use. | Learn how to access and use the Kaltura API. |
| Kaltura API and TestMe Console Introduction | A basic introduction to the Kaltura "TestMe" Console - A tool that provides interaction with Kaltura API calls using a simple user interface. | What is the Kaltura TestMe Console and how to use it to test API calls. |
| Kaltura's API Authentication and Security | Protecting personal user data, video streaming and limiting access to features are at the heart of the Kaltura Media Asset Management Platform. This guide will take you through the basic concepts and practices of authentication and security in the Kaltura API v3. | Learn about Kaltura's API authentication and security options and how to use the Kaltura Session. |
|
The Kaltura Media Access Control Model |
An Access Control Profile defines authorized and restricted domains where your content can or cannot be displayed, countries from which it can or cannot be viewed, white and black lists of IP addresses and authorized and unauthorized domains and devices in which your media can be embedded. | Learn the details of Kaltura’s Access Control Model and how to use it through sample code. |
| Introduction to Kaltura Client Libraries | Kaltura client libraries are SDKs in numerous programming languages that provide easy access to the Kaltura API and facilitate developing Kaltura applications. | Learn about Kaltura client libraries, where to download the clients, and how to use client libraries in your applications. |
| Kaltura Android SDK — Reference Application: Implementation Guide | The Kaltura Android Software Development Kit (SDK) Reference Application demonstrates how to use the Kaltura Android SDK with native Android applications. | Learn how the Kaltura Android SDK Reference Application is implemented. |
| Kaltura iOS SDK — Reference Application: Implementation Guide | The Kaltura iOS Software Development Kit (SDK) Reference Application demonstrates how to use the Kaltura iOS SDK with native iOS applications. | Learn how the Kaltura iOS SDK Reference Application is implemented. |
| The Kaltura Thumbnail API | The Thumbnail API provides an easy interface to dynamically manipulate images or video snapshots to be used as thumbnails. Using the thumbnail API it is possible to resize, cropped versions of the original Kaltura video thumbnail, a specific frame from in the video and manipulate the thumbnail image and various ways.<"> |