Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura compensation API

The compensation API from Kaltura — 3 operation(s) for compensation.

Kaltura compensation API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include compensation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

3 operations 3 paths 2 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura compensation API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

compensation 3
POST
/service/compensation/action/add
Adds a new compensation for a household for a given number of iterations of a subscription renewal for a fixed amount / percentage of the renewal price.
compensation.add 1 param → 200x-Errors
POST
/service/compensation/action/delete
Delete a compensation by identifier
compensation.delete 1 param → 200x-Errors
POST
/service/compensation/action/get
Get a compensation by identifier
compensation.get 1 param → 200x-Errors

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are KalturaCompensation (7 properties), OTTRequest (2 properties). Each schema is shown below with its type and property counts.

KalturaCompensation
object
Compensation request parameters
7 properties
OTTRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-compensation-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API