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 engagementAdapter API

The engagementAdapter API from Kaltura — 6 operation(s) for engagementadapter.

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

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

This API exposes 6 operations across 6 paths, and defines 13 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.

6 operations 6 paths 13 schemas 6 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 engagementAdapter 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 6

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

engagementAdapter 6
POST
/service/engagementadapter/action/add
Insert new Engagement adapter for partner
engagementAdapter.add 1 param → 200x-Errors
POST
/service/engagementadapter/action/delete
Delete Engagement adapter by Engagement adapter id
engagementAdapter.delete 1 param → 200x-Errors
POST
/service/engagementadapter/action/generateSharedSecret
Generate engagement adapter shared secret
engagementAdapter.generateSharedSecret 1 param → 200x-Errors
POST
/service/engagementadapter/action/get
Returns all Engagement adapters for partner : id + name
engagementAdapter.get 1 param → 200
POST
/service/engagementadapter/action/list
Returns all Engagement adapters for partner : id + name
engagementAdapter.list 1 param → 200
POST
/service/engagementadapter/action/update
Update Engagement adapter details
engagementAdapter.update 1 param → 200x-Errors

Schemas 13

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

KalturaLongValue
object
A string representation to return an array of longs
1 property
KalturaEngagementAdapterBase
object
Engagement adapter basic
2 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaEngagementAdapter
object
Engagement Adapter
5 properties
KalturaEngagementAdapterListResponse
object
Engagement adapter list
1 property
KalturaIntegerValue
object
A string representation to return an array of ints
1 property
KalturaDoubleValue
object
A string representation to return an array of doubles
1 property
KalturaMultilingualStringValue
object
Array of translated strings
2 properties
KalturaValue
object
abstract A representation to return an array of values
2 properties
KalturaStringValue
object
A string representation to return an array of strings
1 property
OTTRequest
object
2 properties
KalturaTranslationToken
object
Container for translation
2 properties
KalturaBooleanValue
object
A string representation to return an array of booleans
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-engagementadapter-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