- For list of APIs and documentation of api_v3 - api_v3 API documentation.
- api_v2 is deprecated, please make use of api_v3 client libraries.
Overview
To lower the bar for new developers to enter the world of Kaltura and create customized Kaltura applications, several libraries were written by Kaltura and members of the community in various languages which implement the calls to the Kaltura APIs. These are called client libraries and are encapsulating the API callbacks to ease integration with the partner's native environment.
You can use these in place of raw calls to an API. The client library lets you easily construct queries and use response data as real objects native to your programming language of choice, without having to create HTTP requests or process HTTP responses. The client library provides classes that correspond to the objects and data types used by the Kaltura API services and actions.
The Kaltura Server also provides an automatic way of generating client libraries form a Scheme.xml to keep the client libraries always up to date with the latest api_v3 version.
Available Client Libraries
The list of Client Libraries include both api_v2 and api_v3 client libraries. At the moment, the following api_v3 client libraries are available:
Using the client library
Most of the integration guides uses the PHP5 client library.
The usage of the libraries adhere to the programming language standards to try and simplify as much as possible as well as provide a native integration with the programming language in use. The notion of OOP and services, actions and constants names are similar across all client libraries regardless of the programming language. However implementation may vary from one client library to another depending on the programming language standards.
For example, in Flash ActionScript3 client library all the services are represented as objects and all actions are actions that can be performed on these objects. While in PHP, all actions are implemented directly as the $client object methods that return the newly created objects returned from the Kaltura Server API.
Client Library Set-up
To start working with the client library you must instantiate a KalturaConfiguration instance and KalturaClient instance.
The KalturaClient object will be used to call various actions on the API.
Instantiate an instance of KalturaConfiguration and initialize it with your Kaltura Partner Identifiers (partner id, secret, user id).
The next step is to create a KS, Kaltura Session. Refer to the Kaltura API and TestMe Console Introduction for more information about the session.start API and KS usage.
Only after creating a KS and setting it to the client instance you can use the rest of the API.
To learn about generating client libraries, read the API Client Library Generator Guide
- For further information on the API calls for Partner Services 2 (api_v2), please refer to the old wiki - Please note that api_v2 is deprecated and should be avoided.
- For further information on the API calls for Partner Services 3 (api_v3), please refer to the api_v3 API documentation.
