{ "opencollection": "1.0.0", "info": { "name": "Kaltura OTT accessControl partner API", "version": "3.6.287.20720" }, "items": [ { "info": { "name": "partner", "type": "folder" }, "items": [ { "info": { "name": "partner.count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/count", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Count partner's existing sub-publishers (count includes the partner itself)." }, { "info": { "name": "partner.get", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/get", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieve partner object by Id" }, { "info": { "name": "partner.getInfo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/getInfo", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieve all info attributed to the partner\n\nThis action expects no parameters. It returns information for the current KS partnerId." }, { "info": { "name": "partner.getPublicInfo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/getPublicInfo", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Returns partner public info by Id" }, { "info": { "name": "partner.getSecrets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/getSecrets", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieve partner secret and admin secret" }, { "info": { "name": "partner.getStatistics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/getStatistics", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get usage statistics for a partner\n\nCalculation is done according to partner's package" }, { "info": { "name": "partner.getUsage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/getUsage", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get usage statistics for a partner\n\nCalculation is done according to partner's package\n\nAdditional data returned is a graph points of streaming usage in a time frame\n\nThe resolution can be \"days\" or \"months\"" }, { "info": { "name": "partner.list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/list", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List partners by filter with paging support\n\nCurrent implementation will only list the sub partners of the partner initiating the API call (using the current KS).\n\nThis action is only partially implemented to support listing sub partners of a VAR partner." }, { "info": { "name": "partner.listFeatureStatus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/listFeatureStatus", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List partner's current processes' statuses" }, { "info": { "name": "partner.listPartnersForUser", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/listPartnersForUser", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of partner objects which the current user is allowed to access." }, { "info": { "name": "partner.register", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/register", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Create a new Partner object" }, { "info": { "name": "partner.registrationValidation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/registrationValidation", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Create a new Partner object" }, { "info": { "name": "partner.update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/partner/action/update", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update details and settings of an existing partner" } ] } ], "bundled": true }